Module org.praxislive.core

Package org.praxislive.core

Class ComponentInfo

java.lang.Object

org.praxislive.core.Value

org.praxislive.core.ComponentInfo

public class ComponentInfo
extends Value

Nested Class Summary

Nested classes/interfaces inherited from class org.praxislive.core.Value

Value.Type<T extends Value>

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY_COMPONENT_TYPE
static String	KEY_DYNAMIC

Method Summary

Modifier and Type	Method	Description
ControlInfo	controlInfo(String control)
List<String>	controls()
boolean	equals(Object obj)	Values must override the default equals method.
boolean	equivalent(Value arg)	Indicates whether some other Value is equivalent to this one.
static Optional<ComponentInfo>	from(Value arg)
int	hashCode()	Values must override the default hashcode method.
boolean	hasProtocol(Class<? extends Protocol> protocol)
static ArgumentInfo	info()
static ComponentInfo	parse(String string)
PortInfo	portInfo(String port)
List<String>	ports()
PMap	properties()
Stream<Class<? extends Protocol>>	protocols()
String	toString()	Values must override the default method to return a string representation that is immutable.

Methods inherited from class org.praxislive.core.Value

isEmpty, ofObject, type

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

KEY_COMPONENT_TYPE

public static final String KEY_COMPONENT_TYPE

See Also:

Constant Field Values

KEY_DYNAMIC

public static final String KEY_DYNAMIC

See Also:

Constant Field Values

Method Detail

protocols

public Stream<Class<? extends Protocol>> protocols()

hasProtocol

public boolean hasProtocol(Class<? extends Protocol> protocol)

controls

public List<String> controls()

controlInfo

public ControlInfo controlInfo(String control)

ports

public List<String> ports()

portInfo

public PortInfo portInfo(String port)

properties

public PMap properties()

toString

public String toString()

Description copied from class: Value

Values must override the default method to return a string representation that is immutable.

Specified by:

toString in class Value

Returns:

String representation

equivalent

public boolean equivalent(Value arg)

Description copied from class: Value

Indicates whether some other Value is equivalent to this one. Unlike Value.equals(java.lang.Object) this method is not symmetric - a value of a different type might be equivalent to this without the other type considering the reverse to be true.

The default implementation uses identity or String equality.

Overrides:

equivalent in class Value

Parameters:

arg - value to test for equivalence

Returns:

true if value is equivalent to this

equals

public boolean equals(Object obj)

Description copied from class: Value

Values must override the default equals method. This method should only return true if the supplied Object is of the same type as the implementing Value. Values of an unknown type should be coerced before calling this method. This method does not have to guarantee that this.equals(that) == this.toString().equals(that.toString())

Specified by:

equals in class Value

Returns:

boolean

hashCode

public int hashCode()

Description copied from class: Value

Values must override the default hashcode method.

Specified by:

hashCode in class Value

Returns:

int hashcode

from

public static Optional<ComponentInfo> from(Value arg)

info

public static ArgumentInfo info()

parse

public static ComponentInfo parse(String string)
                           throws ValueFormatException

Throws:

ValueFormatException