org.eth.cyril.graphdrawing.graph.drawing.configuration

Class EmptyConfiguration

java.lang.Object

org.eth.cyril.graphdrawing.graph.drawing.configuration.EmptyConfiguration

All Implemented Interfaces:

JsonSerializable

Direct Known Subclasses:

SugiyamaConfiguration

public class EmptyConfiguration
extends java.lang.Object
implements JsonSerializable

A configuration to be used by a GraphDrawingAlgorithm.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmptyConfiguration.PropertyDescriptor<T> A property descriptor for storing simple properties.

Constructor Summary

Constructors

Constructor and Description
EmptyConfiguration()

Method Summary

Modifier and Type	Method and Description
void	addCost(java.lang.Object cost) Adds a new cost object to this configuration.
protected <T> void	addProperty(EmptyConfiguration.PropertyDescriptor<T> property, T value) Adds a new property to the configuration.
EmptyConfiguration	clone() Returns a clone of this configuration.
void	fromJson(javax.json.JsonValue json)
java.util.List<java.lang.Object>	getCosts() Gets an unmodifiable copy of all the costs associated with this configuration.
<T> java.util.List<T>	getCosts(java.lang.Class<T> clazz) Gets all costs which are assignable to the given class.
<T> T	getProperty(EmptyConfiguration.PropertyDescriptor<T> property) Get the property pointed to by the given property descriptor, if it exists.
<T> java.util.Optional<T>	getPropertySafe(EmptyConfiguration.PropertyDescriptor<T> property) Get the property pointed to by the given property descriptor, if it exists.
protected void	initializeProperties() Initialize the set of properties supported by this configuration.
protected static <T> EmptyConfiguration.PropertyDescriptor<T>	property(java.lang.String name, java.lang.Class<T> clazz)
void	removeCost(java.lang.Object cost) Removes the given cost from this configuration.
void	removeCosts(java.lang.Class<?> clazz) Removes all the costs of the given class (or any subclass) from this configuration.
EmptyConfiguration	setProperty(EmptyConfiguration.PropertyDescriptor<?> property, java.lang.Object value) Set the property for the given property descriptor.
java.util.Set<java.lang.Class<?>>	supportedCostBaseTypes() Returns a set of the supported base types for the costs.
java.util.Set<EmptyConfiguration.PropertyDescriptor<?>>	supportedProperties() Returns the set of property descriptors supported by this configuration.
boolean	supportsCostType(java.lang.Class<?> candidate) Returns whether the given class is among the supported cost types, i.e.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eth.cyril.util.serialization.JsonSerializable

toJson

Constructor Detail

EmptyConfiguration

public EmptyConfiguration()

Method Detail

property

protected static <T> EmptyConfiguration.PropertyDescriptor<T> property(java.lang.String name,
                                                                       java.lang.Class<T> clazz)

getPropertySafe

public <T> java.util.Optional<T> getPropertySafe(EmptyConfiguration.PropertyDescriptor<T> property)

Get the property pointed to by the given property descriptor, if it exists. If it doesn't exist, return an empty optional.

Type Parameters:

T - The type of the property.

Parameters:

property - The property descriptor.

Returns:

An optional containing the property if found, and null otherwise.

getProperty

public <T> T getProperty(EmptyConfiguration.PropertyDescriptor<T> property)
                  throws java.lang.IllegalArgumentException

Get the property pointed to by the given property descriptor, if it exists. If it doesn't exist or is of the wrong type, an exception is thrown.

Type Parameters:

T - The type of the property.

Parameters:

property - The property descriptor.

Returns:

The property of the correct type.

Throws:

java.lang.IllegalArgumentException - If there is no property stored for the given descriptor.

java.lang.ClassCastException - If the stored property is of the wrong type.

setProperty

public EmptyConfiguration setProperty(EmptyConfiguration.PropertyDescriptor<?> property,
                                      java.lang.Object value)
                               throws java.lang.IllegalArgumentException

Set the property for the given property descriptor. This method may only overwrite an existing property, and not add a new property as the set of properties is fixed.

Parameters:

property - The property descriptor.

value - The new property to be set.

Returns:

This configuration.

Throws:

java.lang.IllegalArgumentException - If the property is of the wrong type, or no property for the given property descriptor exists.

supportedProperties

public java.util.Set<EmptyConfiguration.PropertyDescriptor<?>> supportedProperties()

Returns the set of property descriptors supported by this configuration. Trying to call setProperty(PropertyDescriptor, Object) or getProperty(PropertyDescriptor) for any other property will throw an exception.

addCost

public void addCost(java.lang.Object cost)
             throws java.lang.IllegalArgumentException

Adds a new cost object to this configuration. The cost object must be of a supported type. See also supportsCostType(Class) to check whether the given object's type is supported by this configuration.

Parameters:

cost - The cost object to add.

Throws:

java.lang.IllegalArgumentException - If the type of the cost object is not supported.

removeCost

public void removeCost(java.lang.Object cost)

Removes the given cost from this configuration. If the cost does not exist, nothing happens.

Parameters:

cost - The cost to be removed.

removeCosts

public void removeCosts(java.lang.Class<?> clazz)

Removes all the costs of the given class (or any subclass) from this configuration. If no such costs exist, nothing happens.

Parameters:

clazz - The class of which to remove all costs.

getCosts

public java.util.List<java.lang.Object> getCosts()

Gets an unmodifiable copy of all the costs associated with this configuration.

getCosts

public <T> java.util.List<T> getCosts(java.lang.Class<T> clazz)

Gets all costs which are assignable to the given class.

Type Parameters:

T - The type of costs to find.

Parameters:

clazz - The class of which to find all costs.

Returns:

A list of all costs which are assignable to the given class.

supportedCostBaseTypes

public java.util.Set<java.lang.Class<?>> supportedCostBaseTypes()

Returns a set of the supported base types for the costs.

supportsCostType

public boolean supportsCostType(java.lang.Class<?> candidate)

Returns whether the given class is among the supported cost types, i.e. if it is assignable to any of the classes from supportedCostBaseTypes().

Parameters:

candidate - The candiate class.

Returns:

Whether the given class is supported as a cost type.

clone

public EmptyConfiguration clone()

Returns a clone of this configuration. The clone will be of the same type as the old configuration.

Overrides:

clone in class java.lang.Object

fromJson

public void fromJson(javax.json.JsonValue json)

Specified by:

fromJson in interface JsonSerializable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

addProperty

protected <T> void addProperty(EmptyConfiguration.PropertyDescriptor<T> property,
                               T value)

Adds a new property to the configuration.

Type Parameters:

T - The type of the new property.

Parameters:

property - The property descriptor.

value - The new property to be added.a

initializeProperties

protected void initializeProperties()

Initialize the set of properties supported by this configuration. See addProperty(PropertyDescriptor, Object) as a way to add new properties in this method.