CatalogItemDtoAbstract (Apache Brooklyn)

java.lang.Object
- brooklyn.basic.AbstractBrooklynObject
- - brooklyn.catalog.internal.CatalogItemDtoAbstract<T,SpecT>

All Implemented Interfaces:

BrooklynObject, BrooklynObjectInternal, CatalogItem<T,SpecT>, Rebindable, Identifiable

Direct Known Subclasses:

CatalogConfigurationDto, CatalogEntityItemDto, CatalogPolicyItemDto, CatalogTemplateItemDto
```
public abstract class CatalogItemDtoAbstract<T,SpecT>
extends AbstractBrooklynObject
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

CatalogItemDtoAbstract()

Constructors
Constructor and Description
`CatalogItemDtoAbstract()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDescription()`
`java.lang.String`	`getDisplayName()` A display name; recommended to be a concise single-line description.
`java.lang.String`	`getIconUrl()`
`java.lang.String`	`getId()`
`java.lang.String`	`getJavaType()`
`CatalogItem.CatalogItemLibraries`	`getLibraries()`
`CatalogLibrariesDto`	`getLibrariesDto()`
`java.lang.String`	`getName()` Deprecated.
`java.lang.String`	`getPlanYaml()`
`RebindSupport<CatalogItemMemento>`	`getRebindSupport()`
`java.lang.String`	`getRegisteredTypeName()`
`abstract java.lang.Class<SpecT>`	`getSpecType()`
`java.lang.String`	`getVersion()`
`void`	`setCatalogItemId(java.lang.String id)` Use of this method is discouraged unless it is assigning the same (final) ID that this object already has.
`void`	`setDisplayName(java.lang.String newName)`
`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 brooklyn.basic.AbstractBrooklynObject
getCatalogItemId, getManagementContext, getTagSupport, init, rebind, setManagementContext

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

Methods inherited from interface brooklyn.catalog.CatalogItem
getCatalogItemId, getCatalogItemJavaType, getCatalogItemType

Methods inherited from interface brooklyn.basic.BrooklynObject
getTagSupport

- Constructor Detail
  - CatalogItemDtoAbstract
```
public CatalogItemDtoAbstract()
```
- Method Detail
  - getId
```
public java.lang.String getId()
```
    Specified by:
    
    getId in interface Identifiable
    
    Overrides:
    
    getId in class AbstractBrooklynObject
  - 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
  - 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>
  - getLibrariesDto
```
public CatalogLibrariesDto getLibrariesDto()
```
  - getPlanYaml
```
@Nullable
public java.lang.String getPlanYaml()
```
    Specified by:
    
    getPlanYaml in interface CatalogItem<T,SpecT>
    
    Returns:
    The underlying YAML for this item, if known
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getSpecType
```
public abstract 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()
  - toXmlString
```
public java.lang.String toXmlString()
```
    Specified by:
    
    toXmlString in interface CatalogItem<T,SpecT>
  - getRebindSupport
```
public RebindSupport<CatalogItemMemento> getRebindSupport()
```
    Specified by:
    
    getRebindSupport in interface CatalogItem<T,SpecT>
    
    Specified by:
    
    getRebindSupport in interface Rebindable
  - setDisplayName
```
public void setDisplayName(java.lang.String newName)
```
    Specified by:
    
    setDisplayName in class AbstractBrooklynObject
  - 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
    
    Overrides:
    
    tags in class AbstractBrooklynObject
  - setCatalogItemId
```
public void setCatalogItemId(java.lang.String id)
```
    Use of this method is discouraged unless it is assigning the same (final) ID that this object already has.
    
    Specified by:
    
    setCatalogItemId in interface BrooklynObjectInternal
    
    Overrides:
    
    setCatalogItemId in class AbstractBrooklynObject

Class CatalogItemDtoAbstract<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 brooklyn.basic.AbstractBrooklynObject

Methods inherited from class java.lang.Object

Methods inherited from interface brooklyn.catalog.CatalogItem

Methods inherited from interface brooklyn.basic.BrooklynObject

Constructor Detail

CatalogItemDtoAbstract

Method Detail

getId

getRegisteredTypeName

getJavaType

getName

getDisplayName

getDescription

getIconUrl

getVersion

getLibraries

getLibrariesDto

getPlanYaml

toString

getSpecType

toXmlString

getRebindSupport

setDisplayName

tags

setCatalogItemId