com.opengamma.strata.product.common.ExchangeId Maven / Gradle / Ivy

Go to download

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

Domain objects describing trades and products in financial markets

There is a newer version: 2.12.48

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

import java.io.Serializable;

import org.joda.convert.FromString;
import org.joda.convert.ToString;

import com.opengamma.strata.collect.ArgChecker;
import com.opengamma.strata.collect.named.Named;

/**
 * An identifier for an exchange based on the ISO Market Identifier Code (MIC).
 * 
 * Identifiers for common exchanges are provided in {@link ExchangeIds}.
 */
public final class ExchangeId implements Named, Serializable {

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

  /**
   * The Market Identifier Code (MIC) identifying the exchange.
   */
  private final String name;

  //-------------------------------------------------------------------------
  /**
   * Returns an identifier for the exchange.
   *
   * @param name the Market Identifier Code (MIC) identifying the exchange
   * @return an identifier for the exchange
   */
  @FromString
  public static ExchangeId of(String name) {
    return new ExchangeId(name);
  }

  // restricted constructor
  private ExchangeId(String name) {
    this.name = ArgChecker.notBlank(name, "name");
  }

  // resolve after deserialization
  private Object readResolve() {
    return of(name);
  }

  //-------------------------------------------------------------------------
  /**
   * Returns the Market Identifier Code (MIC) identifying the exchange.
   *
   * @return the Market Identifier Code (MIC) identifying the exchange
   */
  @Override
  public String getName() {
    return name;
  }

  //-------------------------------------------------------------------------
  /**
   * Checks if this identifier equals another identifier.
   * 
   * The comparison checks the name.
   * 
   * @param obj  the other identifier, null returns false
   * @return true if equal
   */
  @Override
  public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null || getClass() != obj.getClass()) {
      return false;
    }
    ExchangeId that = (ExchangeId) obj;
    return name.equals(that.name);
  }

  /**
   * Returns a suitable hash code for the identifier.
   * 
   * @return the hash code
   */
  @Override
  public int hashCode() {
    return name.hashCode();
  }

  @ToString
  @Override
  public String toString() {
    return name;
  }

}