DefaultCubeMetadata (OpenGamma Strata Market)

java.lang.Object
- com.opengamma.strata.market.cube.DefaultCubeMetadata

All Implemented Interfaces:

CubeMetadata, Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean
```
public final class DefaultCubeMetadata
extends Object
implements CubeMetadata, org.joda.beans.ImmutableBean, Serializable
```
Default metadata for a cube.
This implementation of CubeMetadata provides the cube name and nodes.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DefaultCubeMetadata.Meta
The meta-bean for DefaultCubeMetadata.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DefaultCubeMetadata.Meta` The meta-bean for `DefaultCubeMetadata`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DefaultCubeMetadataBuilder`	`builder()` Returns a builder used to create an instance of the bean.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`findInfo(CubeInfoType<T> type)` Finds cube information of a specific type.
`CubeName`	`getCubeName()` Gets the cube name.
`ImmutableMap<CubeInfoType<?>,Object>`	`getInfo()` Gets the additional cube information.
`<T> T`	`getInfo(CubeInfoType<T> type)` Gets cube information of a specific type.
`Optional<List<ParameterMetadata>>`	`getParameterMetadata()` Gets the metadata about the parameters.
`ValueType`	`getWValueType()` Gets the w-value type, providing meaning to the w-values of the cube.
`ValueType`	`getXValueType()` Gets the x-value type, providing meaning to the x-values of the cube.
`ValueType`	`getYValueType()` Gets the y-value type, providing meaning to the y-values of the cube.
`ValueType`	`getZValueType()` Gets the z-value type, providing meaning to the z-values of the cube.
`int`	`hashCode()`
`static DefaultCubeMetadata.Meta`	`meta()` The meta-bean for `DefaultCubeMetadata`.
`DefaultCubeMetadata.Meta`	`metaBean()`
`static DefaultCubeMetadata`	`of(CubeName name)` Creates the metadata.
`static DefaultCubeMetadata`	`of(String name)` Creates the metadata.
`DefaultCubeMetadataBuilder`	`toBuilder()` Returns a mutable builder initialized with the state of this bean.
`String`	`toString()`
`<T> DefaultCubeMetadata`	`withInfo(CubeInfoType<T> type, T value)` Returns an instance where the specified additional information has been added.
`DefaultCubeMetadata`	`withParameterMetadata(List<? extends ParameterMetadata> parameterMetadata)` Returns an instance where the parameter metadata has been changed.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.opengamma.strata.market.cube.CubeMetadata
findParameterIndex, getParameterMetadata

Methods inherited from interface org.joda.beans.Bean
property, propertyNames

- Method Detail
  - of
```
public static DefaultCubeMetadata of(String name)
```
    Creates the metadata.
    No information will be available for the x-values, y-values, z-values, w-values or parameters.
    
    Parameters:
    
    name - the cube name
    
    Returns:
    
    the metadata
  - of
```
public static DefaultCubeMetadata of(CubeName name)
```
    Creates the metadata.
    No information will be available for the x-values, y-values, z-values or parameters.
    
    Parameters:
    
    name - the cube name
    
    Returns:
    
    the metadata
  - builder
```
public static DefaultCubeMetadataBuilder builder()
```
    Returns a builder used to create an instance of the bean.
    
    Returns:
    
    the builder, not null
  - getInfo
```
public <T> T getInfo(CubeInfoType<T> type)
```
    Description copied from interface: CubeMetadata
    
    Gets cube information of a specific type.
    If the information is not found, an exception is thrown.
    
    Specified by:
    
    getInfo in interface CubeMetadata
    
    Type Parameters:
    
    T - the type of the info
    
    Parameters:
    
    type - the type to find
    
    Returns:
    
    the cube information
  - findInfo
```
public <T> Optional<T> findInfo(CubeInfoType<T> type)
```
    Description copied from interface: CubeMetadata
    
    Finds cube information of a specific type.
    If the info is not found, optional empty is returned.
    
    Specified by:
    
    findInfo in interface CubeMetadata
    
    Type Parameters:
    
    T - the type of the info
    
    Parameters:
    
    type - the type to find
    
    Returns:
    
    the cube information
  - withInfo
```
public <T> DefaultCubeMetadata withInfo(CubeInfoType<T> type,
                                        T value)
```
    Description copied from interface: CubeMetadata
    
    Returns an instance where the specified additional information has been added.
    The additional information is stored in the result using Map.put semantics, removing the key if the instance is null.
    
    Specified by:
    
    withInfo in interface CubeMetadata
    
    Type Parameters:
    
    T - the type of the info
    
    Parameters:
    
    type - the type to store under
    
    value - the value to store, may be null
    
    Returns:
    
    the new cube metadata
  - withParameterMetadata
```
public DefaultCubeMetadata withParameterMetadata(List<? extends ParameterMetadata> parameterMetadata)
```
    Description copied from interface: CubeMetadata
    
    Returns an instance where the parameter metadata has been changed.
    The result will contain the specified parameter metadata. A null value is accepted and causes the result to have no parameter metadata.
    
    Specified by:
    
    withParameterMetadata in interface CubeMetadata
    
    Parameters:
    
    parameterMetadata - the new parameter metadata, may be null
    
    Returns:
    
    the new cube metadata
  - toBuilder
```
public DefaultCubeMetadataBuilder toBuilder()
```
    Returns a mutable builder initialized with the state of this bean.
    
    Returns:
    
    the mutable builder, not null
  - meta
```
public static DefaultCubeMetadata.Meta meta()
```
    The meta-bean for DefaultCubeMetadata.
    
    Returns:
    
    the meta-bean, not null
  - metaBean
```
public DefaultCubeMetadata.Meta metaBean()
```
    Specified by:
    
    metaBean in interface org.joda.beans.Bean
  - getCubeName
```
public CubeName getCubeName()
```
    Gets the cube name.
    
    Specified by:
    
    getCubeName in interface CubeMetadata
    
    Returns:
    
    the value of the property, not null
  - getXValueType
```
public ValueType getXValueType()
```
    Gets the x-value type, providing meaning to the x-values of the cube.
    This type provides meaning to the x-values. For example, the x-value might represent a year fraction, as represented using ValueType.YEAR_FRACTION.
    If using the builder, this defaults to ValueType.UNKNOWN.
    
    Specified by:
    
    getXValueType in interface CubeMetadata
    
    Returns:
    
    the value of the property, not null
  - getYValueType
```
public ValueType getYValueType()
```
    Gets the y-value type, providing meaning to the y-values of the cube.
    This type provides meaning to the y-values.
    If using the builder, this defaults to ValueType.UNKNOWN.
    
    Specified by:
    
    getYValueType in interface CubeMetadata
    
    Returns:
    
    the value of the property, not null
  - getZValueType
```
public ValueType getZValueType()
```
    Gets the z-value type, providing meaning to the z-values of the cube.
    This type provides meaning to the z-values.
    If using the builder, this defaults to ValueType.UNKNOWN.
    
    Specified by:
    
    getZValueType in interface CubeMetadata
    
    Returns:
    
    the value of the property, not null
  - getWValueType
```
public ValueType getWValueType()
```
    Gets the w-value type, providing meaning to the w-values of the cube.
    This type provides meaning to the w-values.
    If using the builder, this defaults to ValueType.UNKNOWN.
    
    Specified by:
    
    getWValueType in interface CubeMetadata
    
    Returns:
    
    the value of the property, not null
  - getInfo
```
public ImmutableMap<CubeInfoType<?>,Object> getInfo()
```
    Gets the additional cube information.
    This stores additional information for the cube.
    
    Returns:
    
    the value of the property, not null
  - getParameterMetadata
```
public Optional<List<ParameterMetadata>> getParameterMetadata()
```
    Gets the metadata about the parameters.
    If present, the parameter metadata should match the number of parameters on the cube.
    
    Specified by:
    
    getParameterMetadata in interface CubeMetadata
    
    Returns:
    
    the optional 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

Copyright 2009-Present by OpenGamma Inc. and individual contributors
Apache v2 licensed
Additional documentation can be found at strata.opengamma.io.

Class DefaultCubeMetadata

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.opengamma.strata.market.cube.CubeMetadata

Methods inherited from interface org.joda.beans.Bean

Method Detail

of

of

builder

getInfo

findInfo

withInfo

withParameterMetadata

toBuilder

meta

metaBean

getCubeName

getXValueType

getYValueType

getZValueType

getWValueType

getInfo

getParameterMetadata

equals

hashCode

toString