Package com.inductiveautomation.ignition.common.tags.model

Enum Class InheritanceRelationship

java.lang.Object

java.lang.Enum<InheritanceRelationship>

com.inductiveautomation.ignition.common.tags.model.InheritanceRelationship

All Implemented Interfaces:

Serializable, Comparable<InheritanceRelationship>, Constable

public enum InheritanceRelationship
extends Enum<InheritanceRelationship>

Represents the inheritance relationship between two types (described as "type A" and "type B" in relation to the values).

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
DirectSubType	Type A is a direct sub-type of Type B.
DirectSuperType	Type A is the direct parent of Type B
MissingTypeInfo	Indicates that type information is missing for one of the ids
None	Both types are known, but not related.
Same	If both types are equal
SubType	Type A is a sub type ancestor of Type B, but not a direct sub type.
SuperType	Type A is a super ancestor of Type B, but not its direct supertype.

Method Summary

Modifier and Type	Method	Description
boolean	compatible(InheritanceRelationship other)	Returns whether this relationship is "compatible" with the other- if it's equal, or if this is more permissive than the actual relationship.
static InheritanceRelationship	fromString(String value)
InheritanceRelationship	invert()	Inverts the relationship.
boolean	isDeep()
static InheritanceRelationship	valueOf(String name)	Returns the enum constant of this class with the specified name.
static InheritanceRelationship[]	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

MissingTypeInfo

public static final InheritanceRelationship MissingTypeInfo

Indicates that type information is missing for one of the ids

None

public static final InheritanceRelationship None

Both types are known, but not related.

Same

public static final InheritanceRelationship Same

If both types are equal

DirectSuperType

public static final InheritanceRelationship DirectSuperType

Type A is the direct parent of Type B

SuperType

public static final InheritanceRelationship SuperType

Type A is a super ancestor of Type B, but not its direct supertype.

DirectSubType

public static final InheritanceRelationship DirectSubType

Type A is a direct sub-type of Type B.

SubType

public static final InheritanceRelationship SubType

Type A is a sub type ancestor of Type B, but not a direct sub type.

Method Details

values

public static InheritanceRelationship[] 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 InheritanceRelationship 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

compatible

public boolean compatible(InheritanceRelationship other)

Returns whether this relationship is "compatible" with the other- if it's equal, or if this is more permissive than the actual relationship.

invert

public InheritanceRelationship invert()

Inverts the relationship. Only applicable for sub/super types. Other values return themselves.

isDeep

public boolean isDeep()

fromString

public static InheritanceRelationship fromString(String value)