com.google.jenkins.plugins.metadata

Class MetadataContainer

java.lang.Object

hudson.model.InvisibleAction

com.google.jenkins.plugins.metadata.MetadataContainer

All Implemented Interfaces:

hudson.model.Action, hudson.model.ModelObject

public class MetadataContainer
extends hudson.model.InvisibleAction

A build's InvisibleAction containing metadata. This is intended as append-only store for metadata information. Metadata providing code simply call add(MetadataValue) to contribute metadata, and getMetadata() to consume metadata.

Constructor Summary

Constructors

Constructor and Description
MetadataContainer()

Method Summary

Methods

Modifier and Type	Method and Description
MetadataContainer	add(MetadataValue mv) Add a MetadataValue to this container.
<T extends MetadataValue> MetadataContainer	addAll(Iterable<T> mvs) add a list of elements
<T extends MetadataValue> T	deserialize(Class<T> clazz, String serialized)
com.google.common.collect.Multimap<String,MetadataValue>	getMetadata()
static com.google.common.collect.Multimap<String,MetadataValue>	getMetadata(hudson.model.AbstractBuild<?,?> build)
Map<String,String>	getSerializedMetadata()
<T extends MetadataValue> Iterable<T>	listDeserialize(Class<T> clazz, String serialized)
<T extends MetadataValue> String	listSerialize(Iterable<T> values)
static MetadataContainer	of(hudson.model.AbstractBuild<?,?> build)
void	removeAll(String key) remove a list of elements
String	serialize(MetadataValue metadataValue)

Methods inherited from class hudson.model.InvisibleAction

getDisplayName, getIconFileName, getUrlName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetadataContainer

public MetadataContainer()

Method Detail

getMetadata

public com.google.common.collect.Multimap<String,MetadataValue> getMetadata()

Returns:

the metadata contained.

add

public MetadataContainer add(MetadataValue mv)

Add a MetadataValue to this container.

Parameters:

mv - the given MetadataValue to add.

Returns:

this MetadataContainer.

addAll

public <T extends MetadataValue> MetadataContainer addAll(Iterable<T> mvs)

add a list of elements

removeAll

public void removeAll(String key)

remove a list of elements

getSerializedMetadata

public Map<String,String> getSerializedMetadata()

Returns:

the serialized form of the metadata;

of

public static MetadataContainer of(hudson.model.AbstractBuild<?,?> build)

Parameters:

build - a given build.

Returns:

the MetadataContainer for the given build.

serialize

public String serialize(MetadataValue metadataValue)
                 throws MetadataSerializationException

Parameters:

metadataValue - the metadata value to be serialized.

Returns:

serialized form of the given MetadataValue.

Throws:

MetadataSerializationException - when serialization runs into problem.

listSerialize

public <T extends MetadataValue> String listSerialize(Iterable<T> values)

Parameters:

values - the metadata values to be serialized.

Returns:

serialized form of the given MetadataValue.

Throws:

MetadataSerializationException - when serialization runs into problem.

deserialize

public <T extends MetadataValue> T deserialize(Class<T> clazz,
                                      String serialized)

Parameters:

clazz - class of the MetadataValue object to be deserialized.

serialized - the string to deserialize.

Returns:

the deserialized MetadataValue object.

listDeserialize

public <T extends MetadataValue> Iterable<T> listDeserialize(Class<T> clazz,
                                                    String serialized)

Parameters:

clazz - the class of the MetadataValue to be deserialize.

serialized - the serialized form to be deserialized.

Returns:

a list of deserialized objects.

getMetadata

public static com.google.common.collect.Multimap<String,MetadataValue> getMetadata(hudson.model.AbstractBuild<?,?> build)

Parameters:

build - a given AbstractBuild.

Returns:

the metadata contained in the MetadataContainer of the given AbstractBuild.