org.apache.brooklyn.core.typereg

Class BasicRegisteredType

java.lang.Object

org.apache.brooklyn.core.typereg.BasicRegisteredType

All Implemented Interfaces:

Identifiable, RegisteredType

public class BasicRegisteredType
extends java.lang.Object
implements RegisteredType

Instances are usually created by methods in RegisteredTypes.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.typereg.RegisteredType

RegisteredType.TypeImplementationPlan

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.Set<java.lang.String>	getAliases() Alias words defined for this type
ConfigBag	getCache()
java.lang.String	getContainingBundle() Bundle in symbolicname:id format where this type is defined
java.lang.String	getDescription()
java.lang.String	getDisplayName()
java.lang.String	getIconUrl()
java.lang.String	getId()
BrooklynTypeRegistry.RegisteredTypeKind	getKind()
java.util.Collection<OsgiBundleWithUrl>	getLibraries() Library bundle search path that this item declares for resolving types - registered types from these bundles should be preferred, java types from these bundles will be accessible during construction, and if the resulting instance maintains a search path these bundles will be declared there.
RegisteredType.TypeImplementationPlan	getPlan()
java.util.Set<java.lang.Object>	getSuperTypes()
java.lang.String	getSymbolicName()
java.util.Set<java.lang.Object>	getTags() Tags attached to this item
java.lang.String	getVersion()
VersionedName	getVersionedName()
int	hashCode()
boolean	isDeprecated()
boolean	isDisabled()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface Identifiable

Specified by:

getId in interface RegisteredType

getKind

public BrooklynTypeRegistry.RegisteredTypeKind getKind()

Specified by:

getKind in interface RegisteredType

getSymbolicName

public java.lang.String getSymbolicName()

Specified by:

getSymbolicName in interface RegisteredType

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface RegisteredType

getVersionedName

public VersionedName getVersionedName()

Specified by:

getVersionedName in interface RegisteredType

getContainingBundle

public java.lang.String getContainingBundle()

Description copied from interface: RegisteredType

Bundle in symbolicname:id format where this type is defined

Specified by:

getContainingBundle in interface RegisteredType

getLibraries

public java.util.Collection<OsgiBundleWithUrl> getLibraries()

Description copied from interface: RegisteredType

Library bundle search path that this item declares for resolving types - registered types from these bundles should be preferred, java types from these bundles will be accessible during construction, and if the resulting instance maintains a search path these bundles will be declared there.

This does not include bundles from parent registered types for this item (unless the designer re-declares them explicitly), but typical implementations of instantiation will find those at construction time and if the resulting instance maintains a search path those items will typically be added there.

Specified by:

getLibraries in interface RegisteredType

getDisplayName

public java.lang.String getDisplayName()

Specified by:

getDisplayName in interface RegisteredType

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface RegisteredType

getIconUrl

public java.lang.String getIconUrl()

Specified by:

getIconUrl in interface RegisteredType

getSuperTypes

public java.util.Set<java.lang.Object> getSuperTypes()

Specified by:

getSuperTypes in interface RegisteredType

Returns:

all declared supertypes or super-interfaces of this registered type, consisting of a collection of Class or RegisteredType

This should normally include at least one Class object for filtering purposes: For beans, this should include the java type that the BrooklynTypeRegistry will create. For specs, this should refer to the BrooklynObject type that the created spec will point at (e.g. the concrete Entity, not the EntitySpec).

For specs, this will normally return the most specific java interface it will create (e.g. BasicEntity), then the category (e.g. Entity), then other ancestor classes/interfaces. Registered supertypes and potentially marker registered type interfaces may also be included.

In some places, e.g. for items not yet validated or fully loaded, this list may be incomplete, but it should normally for specs include at least the category the spec will create.

This may include multiple interfaces but exclude the concrete subclass which implements them all (for instance if that concrete implementation is an internal private class). However it must be possible for the corresponding transformer to instantiate that type at runtime. (It will never return two classes which cannot have a common subclass.)

Any RegisteredType instances returned by this method may be stale. (TODO Currently I don't think it ever includes RegisteredType supertypes.)

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface RegisteredType

Returns:

True if the item has been disabled (i.e. its use is forbidden, except for pre-existing apps)

isDeprecated

public boolean isDeprecated()

Specified by:

isDeprecated in interface RegisteredType

Returns:

True if the item has been deprecated (i.e. its use is discouraged)

getAliases

public java.util.Set<java.lang.String> getAliases()

Description copied from interface: RegisteredType

Alias words defined for this type

Specified by:

getAliases in interface RegisteredType

getTags

public java.util.Set<java.lang.Object> getTags()

Description copied from interface: RegisteredType

Tags attached to this item

Specified by:

getTags in interface RegisteredType

getCache

public ConfigBag getCache()

getPlan

public RegisteredType.TypeImplementationPlan getPlan()

Specified by:

getPlan in interface RegisteredType

Returns:

implementation details, so that the framework can find a suitable BrooklynTypePlanTransformer which can then use this object to instantiate this type

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface RegisteredType

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface RegisteredType

Overrides:

equals in class java.lang.Object