net.sf.adatagenerator.api
Interface GeneratedPair<R>

All Superinterfaces:

Cloneable, com.choicemaker.shared.api.CMPair<R>, Iterable<R>

All Known Subinterfaces:

SynthesizedPair<R>

All Known Implementing Classes:

DefaultSynthesizedPair

public interface GeneratedPair<R>
extends com.choicemaker.shared.api.CMPair<R>, Cloneable

A pair of objects that has a set of properties that pertain to the generation of the pair.

Author:

rphall

Nested Class Summary

static class

GeneratedPair.GeneratedDecision

Method Summary

GeneratedPair.GeneratedDecision	getGeneratedDecision()
Properties	getProperties() Returns a copy of this object's properties.
String	getProperty(String pn) Searches for the property with the specified name in the properties of this object.
String	removeProperty(String pn) Removes a property from this object.
void	setProperty(String pn, String pv) Sets a property value for this object.

Methods inherited from interface com.choicemaker.shared.api.CMPair

getLeft, getRight, iterator, setLeft, setRight

Method Detail

getGeneratedDecision

GeneratedPair.GeneratedDecision getGeneratedDecision()

getProperties

Properties getProperties()

Returns a copy of this object's properties.

Returns:

setProperty

void setProperty(String pn,
                 String pv)

Sets a property value for this object.

Parameters:

pn - the (non-null) property name

pv - the (non-null) property value

removeProperty

String removeProperty(String pn)

Removes a property from this object.

Parameters:

pn - the (non-null) property name

Returns:

the value to which the name had been mapped, or null if the name did not have a mapping.

getProperty

String getProperty(String pn)

Searches for the property with the specified name in the properties of this object. The method returns null if the property is not found.

Parameters:

pn - the property name.

Returns:

the value in this property list with the specified key value, or null if the property does not exist.