org.eclipse.ocl.pivot.labels

Class AbstractLabelGeneratorBuilder

java.lang.Object

org.eclipse.ocl.pivot.labels.AbstractLabelGeneratorBuilder

All Implemented Interfaces:

ILabelGenerator.Builder

Direct Known Subclasses:

DefaultLabelGeneratorBuilder

public abstract class AbstractLabelGeneratorBuilder
extends java.lang.Object
implements ILabelGenerator.Builder

AbstractLabelGeneratorBuilder builds the formatted description on behalf of a ILabelGenerator.Builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object	labelledObject
protected java.util.Map<ILabelGenerator.Option<?>,java.lang.Object>	options
protected ILabelGenerator.Registry	registry

Fields inherited from interface org.eclipse.ocl.pivot.labels.ILabelGenerator.Builder

SHOW_CLASS_NAME, SHOW_CLASS_SIMPLE_NAME, SHOW_QUALIFIER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLabelGeneratorBuilder(ILabelGenerator.Registry registry, java.lang.Object labelledObject, java.util.Map<ILabelGenerator.Option<?>,java.lang.Object> options)

Method Summary

Modifier and Type	Method and Description
void	appendObject(java.lang.Object object) Append the generated label of an object to the overall generated label.
void	buildLabelFor(java.lang.Object object)
java.lang.Object	getLabelledObject()
<T> T	getOption(ILabelGenerator.Option<T> option)
ILabelGenerator.Registry	getRegistry()
<T> boolean	hasOption(ILabelGenerator.Option<T> option)
<T> void	setOption(ILabelGenerator.Option<T> option, T value)
abstract java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ocl.pivot.labels.ILabelGenerator.Builder

appendString

Field Detail

registry

protected final ILabelGenerator.Registry registry

labelledObject

@Nullable
protected final java.lang.Object labelledObject

options

@Nullable
protected java.util.Map<ILabelGenerator.Option<?>,java.lang.Object> options

Constructor Detail

AbstractLabelGeneratorBuilder

protected AbstractLabelGeneratorBuilder(ILabelGenerator.Registry registry,
                                        @Nullable
                                        java.lang.Object labelledObject,
                                        @Nullable
                                        java.util.Map<ILabelGenerator.Option<?>,java.lang.Object> options)

Method Detail

appendObject

public void appendObject(@Nullable
                         java.lang.Object object)

Description copied from interface: ILabelGenerator.Builder

Append the generated label of an object to the overall generated label.

Specified by:

appendObject in interface ILabelGenerator.Builder

Parameters:

object - to be appended.

buildLabelFor

public void buildLabelFor(@Nullable
                          java.lang.Object object)

Specified by:

buildLabelFor in interface ILabelGenerator.Builder

getLabelledObject

@Nullable
public java.lang.Object getLabelledObject()

Specified by:

getLabelledObject in interface ILabelGenerator.Builder

getOption

@Nullable
public <T> T getOption(ILabelGenerator.Option<T> option)

Specified by:

getOption in interface ILabelGenerator.Builder

getRegistry

@NonNull
public ILabelGenerator.Registry getRegistry()

Specified by:

getRegistry in interface ILabelGenerator.Builder

hasOption

public <T> boolean hasOption(ILabelGenerator.Option<T> option)

Specified by:

hasOption in interface ILabelGenerator.Builder

setOption

public <T> void setOption(ILabelGenerator.Option<T> option,
                          @Nullable
                          T value)

Specified by:

setOption in interface ILabelGenerator.Builder

toString

@NonNull
public abstract java.lang.String toString()

Specified by:

toString in interface ILabelGenerator.Builder

Overrides:

toString in class java.lang.Object