com.opengamma.strata.market.cube.CubeName Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of strata-market Show documentation

Entities describing the financial market

There is a newer version: 2.12.48

/*
 * Copyright (C) 2024 - present by OpenGamma Inc. and the OpenGamma group of companies
 *
 * Please see distribution for license.
 */
package com.opengamma.strata.market.cube;

import java.io.Serializable;

import org.joda.convert.FromString;

import com.opengamma.strata.collect.ArgChecker;
import com.opengamma.strata.data.MarketDataName;

/**
 * The name of a cube.
 */
public class CubeName
    extends MarketDataName
    implements Serializable {

  /** Serialization version. */
  private static final long serialVersionUID = 1L;

  /**
   * The name.
   */
  private final String name;

  //-------------------------------------------------------------------------
  /**
   * Obtains an instance from the specified name.
   * 
   * Cube names may contain any character, but must not be empty.
   *
   * @param name  the name of the cube
   * @return a cube name instance with the specified name
   */
  @FromString
  public static CubeName of(String name) {
    return new CubeName(name);
  }

  /**
   * Creates an instance.
   *
   * @param name  the name of the cube
   */
  private CubeName(String name) {
    this.name = ArgChecker.notEmpty(name, "name");
  }

  //-------------------------------------------------------------------------
  @Override
  public Class getMarketDataType() {
    return Cube.class;
  }

  @Override
  public String getName() {
    return name;
  }

}