org.hawkular.inventory.paths

Enum SegmentType

java.lang.Object

java.lang.Enum<SegmentType>

org.hawkular.inventory.paths.SegmentType

All Implemented Interfaces:

Serializable, Comparable<SegmentType>

public enum SegmentType
extends Enum<SegmentType>

An enumeration of all possible Path Path.Segment types.

Author:

Peter Palaga

Enum Constant Summary

Enum Constants

Enum Constant and Description
d DataEntity
e Environment
f Feed
m Metric
mp MetadataPack
mt MetricType
ot OperationType
r Resource
rl Relationship
rt ResourceType
sd StructuredData
t Tenant
up

Field Summary

Fields

Modifier and Type	Field and Description
static SegmentType	ANY_ENTITY Per convention, the null value is interpreted as any subclass of org.hawkular.inventory.api.model.Entity

Method Summary

Modifier and Type	Method and Description
static SegmentType	fastValueOf(String type) A static HashMap based and null-tolerant alternative to valueOf(String).
static SegmentType	fromElementType(Class<?> elementType) Returns a SegmentType corresponding to the given elementType or null if no corresponding type can be found.
static Set<String>	getCanonicalShortNames()
static Set<SegmentType>	getRelativeShortNames()
String	getSerialized() Returns the representation of this SegmentType suitable for serialization.
String	getSimpleName()
boolean	isAllowedInCanonical() All except for up are allowed in CanonicalPath.
boolean	isSerializable() We do not serialize sds with a "sd;" prefix.
static SegmentType	valueOf(String name) Returns the enum constant of this type with the specified name.
static SegmentType[]	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

t

public static final SegmentType t

Tenant

e

public static final SegmentType e

Environment

f

public static final SegmentType f

Feed

m

public static final SegmentType m

Metric

r

public static final SegmentType r

Resource

rt

public static final SegmentType rt

ResourceType

mt

public static final SegmentType mt

MetricType

rl

public static final SegmentType rl

Relationship

d

public static final SegmentType d

DataEntity

ot

public static final SegmentType ot

OperationType

mp

public static final SegmentType mp

MetadataPack

sd

public static final SegmentType sd

StructuredData

up

public static final SegmentType up

Field Detail

ANY_ENTITY

public static final SegmentType ANY_ENTITY

Per convention, the null value is interpreted as any subclass of org.hawkular.inventory.api.model.Entity

Method Detail

values

public static SegmentType[] 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 (SegmentType c : SegmentType.values())
    System.out.println(c);

Returns:

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

valueOf

public static SegmentType valueOf(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:

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

NullPointerException - if the argument is null

fastValueOf

public static SegmentType fastValueOf(String type)

A static HashMap based and null-tolerant alternative to valueOf(String).

Parameters:

type - the short name such as "e" or "f" to map to a SegmentType

Returns:

the SegmentType corresponding to the given type or null of there is no corresponding SegmentType.

fromElementType

public static SegmentType fromElementType(Class<?> elementType)

Returns a SegmentType corresponding to the given elementType or null if no corresponding type can be found.

Performance note: this implementation looks up the given elementType using its elementType.getSimpleName(). Because Class.getSimpleName() invokes String.substring(int) this implementation may suboptimal in many use cases.

Therefore, the usage of this method should be avoided in all situations where there is a better alternative, such as using SEGMENT_TYPE constants defined in the subclasses of org.hawkular.inventory.api.model.Entity or org.hawkular.inventory.api.model.Entity.segmentTypeFromType(Class)

Parameters:

elementType - the type to map to a SegmentType

Returns:

the SegmentType corresponding to the given elementType or null if no corresponding type can be found

getCanonicalShortNames

public static Set<String> getCanonicalShortNames()

Returns:

a Set of short names that may occur in canonical paths

getRelativeShortNames

public static Set<SegmentType> getRelativeShortNames()

Returns:

a Set of short names that may occur in relative paths

isAllowedInCanonical

public boolean isAllowedInCanonical()

All except for up are allowed in CanonicalPath.

Returns:

true if this type of Path.Segment may occur in a CanonicalPath, otherwise false

isSerializable

public boolean isSerializable()

We do not serialize sds with a "sd;" prefix.

Returns:

true unless this is a sd, otherwise false

getSerialized

public String getSerialized()

Returns the representation of this SegmentType suitable for serialization. In most cases the result is equal to Enum.name() with the notable exception of up, the serialized form of which is "..".

Returns:

the representation of this SegmentType suitable for serialization

getSimpleName

public String getSimpleName()

Returns:

the simple name of the corresponding class in org.hawkular.inventory.api.model package.