Enum Class PropagationPolicy

java.lang.Object

java.lang.Enum<PropagationPolicy>

org.incenp.obofoundry.sssom.PropagationPolicy

All Implemented Interfaces:

Serializable, Comparable<PropagationPolicy>, Constable

public enum PropagationPolicy
extends Enum<PropagationPolicy>

The policy that defines how to propagate values between the mapping set level and the level of individual mappings.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AlwaysReplace	Always propagate the value from the source object to the destination objects, regardless of whether a destination object already has a value for the slot being propagated.
Disabled	Never propagate values between mapping set level and individual mappings.
NeverReplace	If any of the destination objects already has a value for the slot being propagated, do not propagate anything.
ReplaceIfUnset	Propagate the value from the source object to the destination objects, only for objects that do not already have a value for the slot being propagated.

Method Summary

Modifier and Type	Method	Description
static PropagationPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PropagationPolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AlwaysReplace

public static final PropagationPolicy AlwaysReplace

Always propagate the value from the source object to the destination objects, regardless of whether a destination object already has a value for the slot being propagated.

ReplaceIfUnset

public static final PropagationPolicy ReplaceIfUnset

Propagate the value from the source object to the destination objects, only for objects that do not already have a value for the slot being propagated.

NeverReplace

public static final PropagationPolicy NeverReplace

If any of the destination objects already has a value for the slot being propagated, do not propagate anything.

Disabled

public static final PropagationPolicy Disabled

Never propagate values between mapping set level and individual mappings.

Method Details

values

public static PropagationPolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PropagationPolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null