CatalogItemDo (Apache Brooklyn)

java.lang.Object
- brooklyn.catalog.internal.CatalogItemDo<T,SpecT>

All Implemented Interfaces:: BrooklynObject, CatalogItem<T,SpecT>, Rebindable, Identifiable

public class CatalogItemDo<T,SpecT>
extends java.lang.Object
implements CatalogItem<T,SpecT>

Nested Class Summary
- Nested classes/interfaces inherited from interface brooklyn.catalog.CatalogItem
  CatalogItem.CatalogItemLibraries, CatalogItem.CatalogItemType
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject
  BrooklynObject.TagSupport

Constructor Summary

Constructors
Constructor and Description

CatalogItemDo(CatalogDo catalog, CatalogItem<T,SpecT> itemDto)

Constructors
Constructor and Description
`CatalogItemDo(CatalogDo catalog, CatalogItem<T,SpecT> itemDto)`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCatalogItemId()` Built up from `Identifiable.getId()` and `CatalogItem.getVersion()`.
`java.lang.Class<T>`	`getCatalogItemJavaType()`
`CatalogItem.CatalogItemType`	`getCatalogItemType()`
`java.lang.String`	`getDescription()`
`java.lang.String`	`getDisplayName()` A display name; recommended to be a concise single-line description.
`CatalogItem<T,SpecT>`	`getDto()`
`java.lang.String`	`getIconUrl()`
`java.lang.String`	`getId()`
`java.lang.Class<T>`	`getJavaClass()` Deprecated. since 0.7.0 this is the legacy mechanism; still needed for policies and apps, but being phased out. new items should use `getPlanYaml()` and `#newClassLoadingContext`
`java.lang.String`	`getJavaType()`
`CatalogItem.CatalogItemLibraries`	`getLibraries()`
`java.lang.String`	`getName()` Deprecated.
`java.lang.String`	`getPlanYaml()`
`RebindSupport<CatalogItemMemento>`	`getRebindSupport()`
`java.lang.String`	`getRegisteredTypeName()`
`java.lang.Class<SpecT>`	`getSpecType()`
`BrooklynObject.TagSupport`	`getTagSupport()` Deprecated.
`java.lang.String`	`getVersion()`
`BrooklynObject.TagSupport`	`tags()` Tags are arbitrary objects which can be attached to an entity for subsequent reference.
`java.lang.String`	`toString()`
`java.lang.String`	`toXmlString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CatalogItemDo
```
public CatalogItemDo(CatalogDo catalog,
             CatalogItem<T,SpecT> itemDto)
```
- Method Detail
  - getDto
```
public CatalogItem<T,SpecT> getDto()
```
  - getCatalogItemType
```
public CatalogItem.CatalogItemType getCatalogItemType()
```
    Specified by:
    
    getCatalogItemType in interface CatalogItem<T,SpecT>
  - getCatalogItemJavaType
```
public java.lang.Class<T> getCatalogItemJavaType()
```
    Specified by:
    
    getCatalogItemJavaType in interface CatalogItem<T,SpecT>
    
    Returns:
    The high-level type of this entity, e.g. Entity (not a specific Entity class)
  - getId
```
public java.lang.String getId()
```
    Specified by:
    
    getId in interface Identifiable
  - getCatalogItemId
```
public java.lang.String getCatalogItemId()
```
    Description copied from interface: CatalogItem
    
    Built up from Identifiable.getId() and CatalogItem.getVersion(). (It is a bit self-referential having this method on this type of BrooklynObject, but it is easier this than making the interface hierarchy more complicated.)
    
    Specified by:
    
    getCatalogItemId in interface BrooklynObject
    
    Specified by:
    
    getCatalogItemId in interface CatalogItem<T,SpecT>
  - getRegisteredTypeName
```
public java.lang.String getRegisteredTypeName()
```
    Specified by:
    
    getRegisteredTypeName in interface CatalogItem<T,SpecT>
    
    Returns:
    The type name registered in the catalog for this item
  - getJavaType
```
public java.lang.String getJavaType()
```
    Specified by:
    
    getJavaType in interface CatalogItem<T,SpecT>
    
    Returns:
    The underlying java type of the item represented, or null if not known (e.g. if it comes from yaml)
  - getName
```
@Deprecated
public java.lang.String getName()
```
    Deprecated.
    
    Specified by:
    
    getName in interface CatalogItem<T,SpecT>
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Description copied from interface: BrooklynObject
    
    A display name; recommended to be a concise single-line description.
    
    Specified by:
    
    getDisplayName in interface BrooklynObject
  - tags
```
public BrooklynObject.TagSupport tags()
```
    Description copied from interface: BrooklynObject
    
    Tags are arbitrary objects which can be attached to an entity for subsequent reference. They must not be null (as ImmutableMap may be used under the covers; also there is little point!); and they should be amenable to our persistence (on-disk serialization) and our JSON serialization in the REST API.
    
    Specified by:
    
    tags in interface BrooklynObject
  - getTagSupport
```
@Deprecated
public BrooklynObject.TagSupport getTagSupport()
```
    Deprecated.
    
    Specified by:
    
    getTagSupport in interface BrooklynObject
  - getDescription
```
public java.lang.String getDescription()
```
    Specified by:
    
    getDescription in interface CatalogItem<T,SpecT>
  - getIconUrl
```
public java.lang.String getIconUrl()
```
    Specified by:
    
    getIconUrl in interface CatalogItem<T,SpecT>
  - getVersion
```
public java.lang.String getVersion()
```
    Specified by:
    
    getVersion in interface CatalogItem<T,SpecT>
  - getLibraries
```
@Nonnull
public CatalogItem.CatalogItemLibraries getLibraries()
```
    Specified by:
    
    getLibraries in interface CatalogItem<T,SpecT>
  - getJavaClass
```
@Deprecated
public java.lang.Class<T> getJavaClass()
```
    Deprecated. since 0.7.0 this is the legacy mechanism; still needed for policies and apps, but being phased out. new items should use getPlanYaml() and #newClassLoadingContext
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toXmlString
```
public java.lang.String toXmlString()
```
    Specified by:
    
    toXmlString in interface CatalogItem<T,SpecT>
  - getSpecType
```
public java.lang.Class<SpecT> getSpecType()
```
    Specified by:
    
    getSpecType in interface CatalogItem<T,SpecT>
    
    Returns:
    The type of the spec e.g. EntitySpec corresponding to CatalogItem.getCatalogItemJavaType()
  - getPlanYaml
```
@Nullable
public java.lang.String getPlanYaml()
```
    Specified by:
    
    getPlanYaml in interface CatalogItem<T,SpecT>
    
    Returns:
    The underlying YAML for this item, if known
  - getRebindSupport
```
public RebindSupport<CatalogItemMemento> getRebindSupport()
```
    Specified by:
    
    getRebindSupport in interface CatalogItem<T,SpecT>
    
    Specified by:
    
    getRebindSupport in interface Rebindable

Class CatalogItemDo<T,SpecT>

Nested Class Summary

Nested classes/interfaces inherited from interface brooklyn.catalog.CatalogItem

Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CatalogItemDo

Method Detail

getDto

getCatalogItemType

getCatalogItemJavaType

getId

getCatalogItemId

getRegisteredTypeName

getJavaType

getName

getDisplayName

tags

getTagSupport

getDescription

getIconUrl

getVersion

getLibraries

getJavaClass

toString

toXmlString

getSpecType

getPlanYaml

getRebindSupport