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
java.util.Set<java.lang.String>	getAliases() Alias words defined for this type
ConfigBag	getCache()
java.lang.String	getDescription()
java.lang.String	getDisplayName()
java.lang.String	getIconUrl()
java.lang.String	getId()
BrooklynTypeRegistry.RegisteredTypeKind	getKind()
java.util.Collection<OsgiBundleWithUrl>	getLibraries()
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()
boolean	isDeprecated()
boolean	isDisabled()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, 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

getLibraries

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

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).

This will normally not return all ancestor classes, and it is not required even to return the most specific java class or classes: such as if the concrete type is private and callers should know only about a particular public interface, or if precise type details are unavailable and all that is known at creation is some higher level interface/supertype (e.g. this may return Entity even though the spec points at a specific subclass, for instance because the YAML has not yet been parsed or OSGi bundles downloaded).

This may include other registered types such as marker interfaces.

It may even 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.

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

@Beta
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