com.sonyericsson.hudson.plugins.metadata.model.values
Interface MetadataValue

All Superinterfaces:

Cloneable, Comparable<Object>, Metadata<MetadataValue>

All Known Implementing Classes:

AbstractMetadataValue, DateMetadataValue, NumberMetadataValue, StringMetadataValue, TreeNodeMetadataValue

public interface MetadataValue
extends Metadata<MetadataValue>, Cloneable, Comparable<Object>

A metadata value interface.

Method Summary

void	addEnvironmentVariables(hudson.EnvVars variables, boolean exposeAll) Adds the environment variables for this Metadata to the variables map.
MetadataValue	clone() Clones this MetadataValue.
boolean	isGenerated() If this value is generated or user created.
void	replacementOf(MetadataValue old) A signal sent to this object that it is the replacement of another object.
void	setGenerated(boolean generated) Set if this value is generated or user created.
net.sf.json.JSONObject	toJson() Convert this object into a JSON object.

Methods inherited from interface com.sonyericsson.hudson.plugins.metadata.model.Metadata

getDescription, getFullName, getFullNameFrom, getFullPath, getName, getParent, getValue, isExposedToEnvironment, setExposeToEnvironment, setParent

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

isGenerated

boolean isGenerated()

If this value is generated or user created.

Returns:

true if generated.

setGenerated

void setGenerated(boolean generated)

Set if this value is generated or user created.

Parameters:

generated - true if generated.

toJson

net.sf.json.JSONObject toJson()

Convert this object into a JSON object.

Returns:

the JSON version.

replacementOf

void replacementOf(MetadataValue old)

A signal sent to this object that it is the replacement of another object. The intention from the system is that the object should take this opportunity to try and salvage as much as possible from the old object.

Parameters:

old - the object that it is the replacement of.

addEnvironmentVariables

void addEnvironmentVariables(hudson.EnvVars variables,
                             boolean exposeAll)

Adds the environment variables for this Metadata to the variables map.

Parameters:

variables - the map of current environment variables.

exposeAll - whether all Metadata should be added to the map. Inherited from the parent.

clone

MetadataValue clone()
                    throws CloneNotSupportedException

Clones this MetadataValue.

Returns:

a clone of this MetadataValue.

Throws:

CloneNotSupportedException - if it cannot be cloned.