public interface RegisteredType extends Identifiable
Modifier and Type | Interface and Description |
---|---|
static interface |
RegisteredType.TypeImplementationPlan |
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
|
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 getId()
getId
in interface Identifiable
BrooklynTypeRegistry.RegisteredTypeKind getKind()
java.lang.String getSymbolicName()
java.lang.String getVersion()
VersionedName getVersionedName()
java.lang.String getContainingBundle()
java.util.Collection<OsgiBundleWithUrl> getLibraries()
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.
java.lang.String getDisplayName()
java.lang.String getDescription()
java.lang.String getIconUrl()
java.util.Set<java.lang.Object> getSuperTypes()
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.)
boolean isDeprecated()
boolean isDisabled()
java.util.Set<java.lang.String> getAliases()
java.util.Set<java.lang.Object> getTags()
RegisteredType.TypeImplementationPlan getPlan()
BrooklynTypePlanTransformer
which can then use this object to instantiate this typeboolean equals(java.lang.Object obj)
equals
in class java.lang.Object
int hashCode()
hashCode
in class java.lang.Object