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

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

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

import com.opengamma.strata.collect.named.EnumNames;
import com.opengamma.strata.collect.named.NamedEnum;

/**
 * Flag indicating whether a trade is "put" or "call".
 * 
 * The concepts of put and call apply to options trading.
 * A call gives the owner the right, but not obligation, to buy the underlying at
 * an agreed price in the future. A put gives a similar option to sell.
 */
public enum PutCall implements NamedEnum {

  /**
   * Put.
   */
  PUT,
  /**
   * Call.
   */
  CALL;

  // helper for name conversions
  private static final EnumNames NAMES = EnumNames.of(PutCall.class);

  //-------------------------------------------------------------------------
  /**
   * Obtains an instance from the specified name.
   * 
   * Parsing handles the mixed case form produced by {@link #toString()} and
   * the upper and lower case variants of the enum constant name.
   * 
   * @param name  the name to parse
   * @return the type
   * @throws IllegalArgumentException if the name is not known
   */
  @FromString
  public static PutCall of(String name) {
    return NAMES.parse(name);
  }

  /**
   * Converts a boolean "is put" flag to the enum value.
   * 
   * @param isPut  the put flag, true for put, false for call
   * @return the equivalent enum
   */
  public static PutCall ofPut(boolean isPut) {
    return isPut ? PUT : CALL;
  }

  //-------------------------------------------------------------------------
  /**
   * Checks if the type is 'Put'.
   * 
   * @return true if put, false if call
   */
  public boolean isPut() {
    return this == PUT;
  }

  /**
   * Checks if the type is 'Call'.
   * 
   * @return true if call, false if put
   */
  public boolean isCall() {
    return this == CALL;
  }

  //-------------------------------------------------------------------------
  /**
   * Supplies the opposite of this value.
   *
   * @return the opposite value
   */
  public PutCall opposite() {
    return isPut() ? CALL : PUT;
  }

  //-------------------------------------------------------------------------
  /**
   * Returns the formatted name of the type.
   * 
   * @return the formatted string representing the type
   */
  @ToString
  @Override
  public String toString() {
    return NAMES.format(this);
  }

}