com.opengamma.strata.measure

Class ValuationZoneTimeDefinition

java.lang.Object

com.opengamma.strata.measure.ValuationZoneTimeDefinition

All Implemented Interfaces:

Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class ValuationZoneTimeDefinition
extends Object
implements org.joda.beans.ImmutableBean, Serializable

Definition of valuation zone and time.

This contains ZoneId and a set of LocalTime to create ZonedDateTime from LocalDate.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValuationZoneTimeDefinition.Meta The meta-bean for ValuationZoneTimeDefinition.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
LocalTime	getDefaultLocalTime() Gets the default local time.
ImmutableList<LocalTime>	getLocalTimes() Gets the local time.
ZoneId	getZoneId() Gets the zone ID.
int	hashCode()
static ValuationZoneTimeDefinition.Meta	meta() The meta-bean for ValuationZoneTimeDefinition.
ValuationZoneTimeDefinition.Meta	metaBean()
static ValuationZoneTimeDefinition	of(LocalTime defaultLocalTime, ZoneId zoneId, LocalTime... localTimes) Obtains an instance.
String	toString()
MarketDataBox<ZonedDateTime>	toZonedDateTime(MarketDataBox<LocalDate> dates) Creates zoned date time.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.joda.beans.Bean

property, propertyNames

Method Detail

of

public static ValuationZoneTimeDefinition of(LocalTime defaultLocalTime,
                                             ZoneId zoneId,
                                             LocalTime... localTimes)

Obtains an instance.

Parameters:

defaultLocalTime - default local time

zoneId - the zone ID

localTimes - the local time

Returns:

the instance

toZonedDateTime

public MarketDataBox<ZonedDateTime> toZonedDateTime(MarketDataBox<LocalDate> dates)

Creates zoned date time.

If the scenario size of dates is greater than the size of localTimes, defaultLocalTime is used. If dates is single value, defaultLocalTime is used.

Parameters:

dates - the local date

Returns:

the zoned date time

meta

public static ValuationZoneTimeDefinition.Meta meta()

The meta-bean for ValuationZoneTimeDefinition.

Returns:

the meta-bean, not null

metaBean

public ValuationZoneTimeDefinition.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getDefaultLocalTime

public LocalTime getDefaultLocalTime()

Gets the default local time.

The default local time will be used if the input date is not scenario value or if the scenario size of the input date exceeds the size of localTimes.

Returns:

the value of the property, not null

getZoneId

public ZoneId getZoneId()

Gets the zone ID.

Returns:

the value of the property, not null

getLocalTimes

public ImmutableList<LocalTime> getLocalTimes()

Gets the local time.

The local time in zoneId. The size is not necessarily the same as the scenario size. defaultLocalTime will be used if extra LocalTime is required.

Returns:

the value of the property, not null

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object