ch.agent.t2.time

Class ImmutableTimeDomainCatalog

java.lang.Object

ch.agent.t2.time.ImmutableTimeDomainCatalog

All Implemented Interfaces:

TimeDomainCatalog

Direct Known Subclasses:

DefaultTimeDomainCatalog

public abstract class ImmutableTimeDomainCatalog
extends Object
implements TimeDomainCatalog

ImmutableTimeDomainCatalog implements the behavior of an immutable time domain catalog. It provides only an empty catalog and is in itself useless. Subclasses pass time domains in their constructors.

Author:

Jean-Paul Vetterli

Constructor Summary

Constructors

Constructor and Description
ImmutableTimeDomainCatalog(TimeDomain... domains) Constructor.

Method Summary

Modifier and Type	Method and Description
Collection<TimeDomain>	get() Return all time domains defined in the catalog.
TimeDomain	get(String label) Return the time domain with the given label.
TimeDomain	get(TimeDomainDefinition def) Return the time domain corresponding to the definition, ignoring the label.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImmutableTimeDomainCatalog

public ImmutableTimeDomainCatalog(TimeDomain... domains)

Constructor. A useful catalog should have at least one domain.

Parameters:

domains - zero or more time domains

Method Detail

get

public Collection<TimeDomain> get()

Description copied from interface: TimeDomainCatalog

Return all time domains defined in the catalog.

Specified by:

get in interface TimeDomainCatalog

Returns:

the collection of time domains

get

public TimeDomain get(String label)
               throws T2Exception

Description copied from interface: TimeDomainCatalog

Return the time domain with the given label. Throw an exception when not found.

Specified by:

get in interface TimeDomainCatalog

Parameters:

label - non-null string

Returns:

a time domain

Throws:

T2Exception

get

public TimeDomain get(TimeDomainDefinition def)

Description copied from interface: TimeDomainCatalog

Return the time domain corresponding to the definition, ignoring the label. When no suitable time domain is found in this catalog, the method returns null.

Specified by:

get in interface TimeDomainCatalog

Parameters:

def - a non-null time domain definition

Returns:

a time domain matching the definition or null