li.cil.oc.api.network

Enum Visibility

java.lang.Object

java.lang.Enum<Visibility>

li.cil.oc.api.network.Visibility

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Visibility>

public enum Visibility
extends java.lang.Enum<Visibility>

Possible reachability values for nodes.

Since all nodes that are connected are packed into the same network, we want some way of controlling what's accessible from where on a low level (to avoid unnecessary messages and unauthorized access).

Note that there is a more specific kind of visibility for components. See Component for more details on that.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Neighbors Nodes with this visibility only receive messages from their immediate neighbors, i.e.
Network Nodes with this visibility can receive messages from any node in its network.
None Nodes with this visibility neither receive nor send messages.

Method Summary

Methods

Modifier and Type	Method and Description
static Visibility	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Visibility[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

None

public static final Visibility None

Nodes with this visibility neither receive nor send messages.

Components with this visibility cannot be seen nor reached by computers.

Neighbors

public static final Visibility Neighbors

Nodes with this visibility only receive messages from their immediate neighbors, i.e. nodes to which a direct connection exists. It can send messages to all nodes visible to it.

Components with this visibility can likewise only be reached by the computer(s) they are directly attached to. For example, if a block component is placed directly next to the computer, or an item installed in the computer (i.e. it is in the computer's inventory).

Network

public static final Visibility Network

Nodes with this visibility can receive messages from any node in its network. It can still only send messages to all nodes visible to it.

Components with this visibility are likewise reachable by all computers in their network. For example, a screen only indirectly connected to a computer will still be addressable by that computer.

Method Detail

values

public static Visibility[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Visibility c : Visibility.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Visibility valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null