Package net.darkhax.bookshelf.common.api

Enum Class PhysicalSide

java.lang.Object

java.lang.Enum<PhysicalSide>

net.darkhax.bookshelf.common.api.PhysicalSide

All Implemented Interfaces:

Serializable, Comparable<PhysicalSide>, Constable

public enum PhysicalSide
extends Enum<PhysicalSide>

Represents a physical location in the client/server network diagram.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLIENT	A physical client.
SERVER	A physical server.

Method Summary

Modifier and Type	Method	Description
boolean	isClient()	Checks if this is a physical client.
boolean	isServer()	Checks if this is a physical server.
static PhysicalSide	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PhysicalSide[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CLIENT

public static final PhysicalSide CLIENT

A physical client. This includes single player, and LAN worlds.

SERVER

public static final PhysicalSide SERVER

A physical server. This includes dedicated servers where client code and logic is not accessible.

Method Details

values

public static PhysicalSide[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PhysicalSide valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

isClient

public boolean isClient()

Checks if this is a physical client.

Returns:

Returns true when on a physical client.

isServer

public boolean isServer()

Checks if this is a physical server.

Returns:

Returns true when on a physical server.