com.sonyericsson.hudson.plugins.metadata.model
Interface Metadata<P extends Metadata>

Type Parameters:
P - The metadata type of the parent.
All Known Subinterfaces:
MetadataDefinition, MetadataValue
All Known Implementing Classes:
AbstractMetadataDefinition, AbstractMetadataValue, DateMetadataDefinition, DateMetadataValue, NumberMetadataDefinition, NumberMetadataValue, StringMetadataDefinition, StringMetadataValue, TreeNodeMetadataDefinition, TreeNodeMetadataValue

public interface Metadata<P extends Metadata>

Common interface for definitions and values.

Author:
Tomas Westling <thomas.westling@sonyericsson.com>

Method Summary
 String getDescription()
          Returns the description of this metadata.
 String getFullName()
          Gives the full name.
 String getFullNameFrom(MetadataParent<P> base)
          Gives the full name.
 String[] getFullPath()
          Gives the full path as a String array..
 String getName()
          Returns the name of this metadata.
 MetadataParent<P> getParent()
          The parent of this metadata.
 Object getValue()
          Get the value.
 boolean isExposedToEnvironment()
          Returns whether or not this should be exposed to the environment.
 void setExposeToEnvironment(boolean expose)
          Set whether this should be exposed to the environment or not.
 void setParent(MetadataParent<P> parent)
          The parent of this metadata.
 

Method Detail

getName

String getName()
Returns the name of this metadata.

Returns:
the name of this metadata.

getDescription

String getDescription()
Returns the description of this metadata.

Returns:
The description of this metadata.

getValue

Object getValue()
Get the value.

Returns:
the value.

getParent

MetadataParent<P> getParent()
The parent of this metadata.

Returns:
the parent.

setParent

void setParent(MetadataParent<P> parent)
The parent of this metadata.

Parameters:
parent - the metadata.

isExposedToEnvironment

boolean isExposedToEnvironment()
Returns whether or not this should be exposed to the environment.

Returns:
whether this should be exposed to the environment or not.

setExposeToEnvironment

void setExposeToEnvironment(boolean expose)
Set whether this should be exposed to the environment or not.

Parameters:
expose - true if this should be exposed, false if not.

getFullName

String getFullName()
Gives the full name.

Returns:
a dot separated path from the base up to this item.

getFullNameFrom

String getFullNameFrom(MetadataParent<P> base)
Gives the full name.

Parameters:
base - the parent to calculate the path from.
Returns:
a dot separated path from the base up to this item.

getFullPath

String[] getFullPath()
Gives the full path as a String array..

Returns:
the full name as a String array instead of a String.


Copyright © 2004-2013. All Rights Reserved.