com.anaptecs.jeaf.junit.openapi.base

Class Stop

java.lang.Object

com.anaptecs.jeaf.junit.openapi.base.Stop

All Implemented Interfaces:

com.anaptecs.jeaf.core.api.ServiceObject, Serializable

Direct Known Subclasses:

POI, UICStop

@Valid
public class Stop
extends Object
implements com.anaptecs.jeaf.core.api.ServiceObject

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Stop.Builder Class implements builder to create a new instance of class Stop.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Stop() Default constructor is only intended to be used for deserialization by tools like Jackson for JSON.
protected	Stop(Stop.Builder pBuilder) Initialize object using the passed builder.

Method Summary

Modifier and Type	Method and Description
void	addToLinks(Collection<LinkObject> pLinks) Method adds all passed objects to links.
void	addToLinks(LinkObject pLinks) Method adds the passed object to links.
static Stop.Builder	builder() Method returns a new builder.
static Stop.Builder	builder(Stop pObject) Method creates a new builder and initialize it with the data from the passed object.
static Stop.Builder	builder(String pName, byte pIndex, SoftLink pTheSoftLink) Method creates a new builder and initializes it with the passed attributes.
void	clearLinks() Method removes all objects from links.
byte	getIndex() Method returns attribute index.
List<LinkObject>	getLinks() Method returns association links.
String	getName() Method returns attribute name.
SoftLink	getTheSoftLink() Method returns association theSoftLink.
void	removeFromLinks(LinkObject pLinks) Method removes the passed object from links.
void	setIndex(byte pIndex) Method sets attribute index.
void	setName(String pName) Method sets attribute name.
void	setTheSoftLink(SoftLink pTheSoftLink) Method sets association theSoftLink.
String	toString() Method creates a new String with the values of all attributes of this class.
StringBuilder	toStringBuilder(String pIndent) Method returns a StringBuilder that can be used to create a String representation of this object.
void	unsetTheSoftLink() Method unsets theSoftLink.

Methods inherited from class java.lang.Object

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

Constructor Detail

Stop

protected Stop()

Default constructor is only intended to be used for deserialization by tools like Jackson for JSON. For "normal" object creation builder should be used instead.

Stop

protected Stop(Stop.Builder pBuilder)

Initialize object using the passed builder.

Parameters:

pBuilder - Builder that should be used to initialize this object. The parameter must not be null.

Method Detail

builder

public static Stop.Builder builder()

Method returns a new builder.

Returns:

Stop.Builder New builder that can be used to create new Stop objects.

builder

public static Stop.Builder builder(Stop pObject)

Method creates a new builder and initialize it with the data from the passed object.

Parameters:

pObject - Object that should be used to initialize the builder. The parameter may be null.

Returns:

Stop.Builder New builder that can be used to create new Stop objects. The method never returns null.

builder

public static Stop.Builder builder(String pName,
                                   byte pIndex,
                                   SoftLink pTheSoftLink)

Method creates a new builder and initializes it with the passed attributes.

getName

public String getName()

Method returns attribute name.

Returns:

String Value to which name is set.

setName

public void setName(String pName)

Method sets attribute name.

Parameters:

pName - Value to which name should be set.

getLinks

public List<LinkObject> getLinks()

Method returns association links.

Returns:

List Value to which links is set. The method never returns null and the returned collection is modifiable.

addToLinks

public void addToLinks(LinkObject pLinks)

Method adds the passed object to links.

Parameters:

pLinks - Object that should be added to links. The parameter must not be null.

addToLinks

public void addToLinks(Collection<LinkObject> pLinks)

Method adds all passed objects to links.

Parameters:

pLinks - Collection with all objects that should be added to links. The parameter must not be null.

removeFromLinks

public void removeFromLinks(LinkObject pLinks)

Method removes the passed object from links.

Parameters:

pLinks - Object that should be removed from links. The parameter must not be null.

clearLinks

public void clearLinks()

Method removes all objects from links.

getIndex

public byte getIndex()

Method returns attribute index.

Returns:

byte Value to which index is set.

setIndex

public void setIndex(byte pIndex)

Method sets attribute index.

Parameters:

pIndex - Value to which index should be set.

getTheSoftLink

public SoftLink getTheSoftLink()

Method returns association theSoftLink.

This class uses so called soft links for decoupling. The actual type that is hidden by theSoftLink is LinkObject

Returns:

SoftLink Value to which theSoftLink is set.

setTheSoftLink

public void setTheSoftLink(SoftLink pTheSoftLink)

Method sets association theSoftLink.

Parameters:

pTheSoftLink - Value to which theSoftLink should be set.

unsetTheSoftLink

public final void unsetTheSoftLink()

Method unsets theSoftLink.

toStringBuilder

public StringBuilder toStringBuilder(String pIndent)

Method returns a StringBuilder that can be used to create a String representation of this object. The returned StringBuilder also takes care about attributes of super classes.

Returns:

StringBuilder StringBuilder representing this object. The method never returns null.

toString

public String toString()

Method creates a new String with the values of all attributes of this class. All references to other objects will be ignored.

Overrides:

toString in class Object

Returns:

String String representation of this object. The method never returns null.