Package nz.org.riskscape.pipeline

Class PipelineMetadata

java.lang.Object

nz.org.riskscape.pipeline.PipelineMetadata

public class PipelineMetadata
extends Object

Some basic metadata that can be associated with a pipeline

Field Summary

Fields

Modifier and Type	Field	Description
static final PipelineMetadata	ANONYMOUS

Constructor Summary

Constructors

Constructor	Description
PipelineMetadata(@NonNull URI location, @NonNull String name, @NonNull String description)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@NonNull String	getDescription()	A description of the pipeline, possibly the description of the model that generated.
@NonNull URI	getLocation()	Where this pipeline came from.
@NonNull String	getName()	A name for this pipeline.
int	hashCode()
String	toString()
PipelineMetadata	withDescription(String newDescription)
PipelineMetadata	withLocation(URI newLocation)
PipelineMetadata	withName(String newName)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ANONYMOUS

public static final PipelineMetadata ANONYMOUS

Constructor Details

PipelineMetadata

public PipelineMetadata(@NonNull
 @NonNull URI location,
 @NonNull
 @NonNull String name,
 @NonNull
 @NonNull String description)

Method Details

withName

public PipelineMetadata withName(String newName)

Returns:

a new PipelineMetadata object with a new name

withDescription

public PipelineMetadata withDescription(String newDescription)

Returns:

a new PipelineMetadata object with a new description

withLocation

public PipelineMetadata withLocation(URI newLocation)

Returns:

a new PipelineMetadata object with a new location

getLocation

@NonNull
public @NonNull URI getLocation()

Where this pipeline came from. Might be a config file that generated it, or a location containing just the source.

getName

@NonNull
public @NonNull String getName()

A name for this pipeline. Could be the name of the model that generated it, or some other suitable descriptor.

getDescription

@NonNull
public @NonNull String getDescription()

A description of the pipeline, possibly the description of the model that generated. Will be an empty string instead of null for ease of handling

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object