Package org.gephi.graph.api.types

Class TimestampCharMap

java.lang.Object

org.gephi.graph.api.types.TimestampMap<Character>

org.gephi.graph.api.types.TimestampCharMap

All Implemented Interfaces:

TimeMap<Double,Character>

public final class TimestampCharMap
extends TimestampMap<Character>

Sorted map where keys are timestamp and values character values.

Constructor Summary

Constructors

Constructor	Description
TimestampCharMap()	Default constructor.
TimestampCharMap(double[] keys, char[] vals)	Constructor with an initial timestamp map.
TimestampCharMap(int capacity)	Constructor with capacity.

Method Summary

Modifier and Type	Method	Description
char	getCharacter(double timestamp)	Get the value for the given timestamp.
char	getCharacter(double timestamp, char defaultValue)	Get the value for the given timestamp.
Class<Character>	getTypeClass()	Returns the value type class.
boolean	isSupported(Estimator estimator)	Returns whether estimator is supported.
char[]	toCharacterArray()	Returns an array of all values in this map.

Methods inherited from class org.gephi.graph.api.types.TimestampMap

clear, contains, equals, get, get, getTimestamps, hashCode, isEmpty, put, remove, size, toKeysArray, toString, toString, toString, toValuesArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TimestampCharMap

public TimestampCharMap()

Default constructor.

The map is empty with zero capacity.

TimestampCharMap

public TimestampCharMap(int capacity)

Constructor with capacity.

Using this constructor can improve performances if the number of timestamps is known in advance as it minimizes array resizes.

Parameters:

capacity - timestamp capacity

TimestampCharMap

public TimestampCharMap(double[] keys,
                        char[] vals)

Constructor with an initial timestamp map.

The keys array must be sorted and contain no duplicates.

Parameters:

keys - initial keys content

vals - initial values content

Method Detail

getCharacter

public char getCharacter(double timestamp)

Get the value for the given timestamp.

Parameters:

timestamp - timestamp

Returns:

found value or the default value if not found

Throws:

IllegalArgumentException - if the element doesn't exist

getCharacter

public char getCharacter(double timestamp,
                         char defaultValue)

Get the value for the given timestamp.

Return defaultValue if the value is not found.

Parameters:

timestamp - timestamp

defaultValue - default value

Returns:

found value or the default value if not found

getTypeClass

public Class<Character> getTypeClass()

Description copied from interface: TimeMap

Returns the value type class.

Specified by:

getTypeClass in interface TimeMap<Double,Character>

Specified by:

getTypeClass in class TimestampMap<Character>

Returns:

type class

toCharacterArray

public char[] toCharacterArray()

Returns an array of all values in this map.

This method may return a reference to the underlying array so clients should make a copy if the array is written to.

Returns:

array of all values

isSupported

public boolean isSupported(Estimator estimator)

Description copied from interface: TimeMap

Returns whether estimator is supported.

Specified by:

isSupported in interface TimeMap<Double,Character>

Specified by:

isSupported in class TimestampMap<Character>

Parameters:

estimator - estimator

Returns:

true if this map supports estimator