flexagon.fd.model2.notification.pojos

Class NotifSnapshotVariable

java.lang.Object

BasePOJO

flexagon.fd.model2.notification.pojos.NotifSnapshotVariable

public class NotifSnapshotVariable
extends BasePOJO

An object representing a release snapshot variable. The metadata is defined on the pipeline which is referenced by a release, and the value is defined on each snapshot for releases that reference that pipeline. For use within Notification Templates.

Constructor Summary

Constructors

Constructor and Description
NotifSnapshotVariable(java.lang.String pName, DataTypeEnum pType, java.lang.String pDescription, java.lang.String pValueAsString) Contructs a release snapshot variable from the given metadata and value.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Returns the name of the release snapshot variable.
java.lang.String	getName() Returns the name of the release snapshot variable.
java.lang.String	getType() Returns the type name of the release snapshot variable (i.e.
DataTypeEnum	getTypeEnum() Returns the datatype for this snapshot variable.
java.io.Serializable	getValue() Returns the value of the release snapshot variable, converted to the corresponding datatype (i.e.
java.lang.String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

NotifSnapshotVariable

public NotifSnapshotVariable(java.lang.String pName,
                             DataTypeEnum pType,
                             java.lang.String pDescription,
                             java.lang.String pValueAsString)

Contructs a release snapshot variable from the given metadata and value.

Parameters:

pName - The name of the release snapshot variable.

pType - The datatype of the release snapshot variable.

pDescription - The description of the release snapshot variable.

pValueAsString - The value of the release snapshot variable as a String. The value will be converted to appropriate primitive wrapper.

Method Detail

getName

public java.lang.String getName()

Returns the name of the release snapshot variable.

Returns:

The snapshot variable name.

getDescription

public java.lang.String getDescription()

Returns the name of the release snapshot variable.

Returns:

The snapshot variable description.

getValue

public java.io.Serializable getValue()

Returns the value of the release snapshot variable, converted to the corresponding datatype (i.e. String, Integer, Long, Double, Boolean).

Returns:

The value of release snapshot variable. Concrete type will be one of [String, Integer, Long, Double, Boolean].

getTypeEnum

public DataTypeEnum getTypeEnum()

Returns the datatype for this snapshot variable.

Returns:

The snapshot variable datatype.

getType

public java.lang.String getType()

Returns the type name of the release snapshot variable (i.e. String, Integer, Long, Double, Boolean).

Returns:

The release snapshot variable datatype name.

toString

public java.lang.String toString()

Returns a string representation of this object.

Returns:

A string representation of the object.