com.paypal.cascade.common.enumeration.EnumReader.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cascade-common_2.11 Show documentation

cascade-common

The newest version!

/**
 * Copyright 2013-2014 PayPal
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.paypal.cascade.common.enumeration

/**
 * Base trait for reading Strings into our [[com.paypal.cascade.common.enumeration.Enumeration]].
 */
trait EnumReader[T] {

  /**
   * Attempt to read a String into an [[com.paypal.cascade.common.enumeration.Enumeration]] subtype
   * @param s the String to read
   * @return optionally, an Enumeration type, or None if no match is made
   */
  def read(s: String): Option[T]

  /**
   * Reads a String into an [[com.paypal.cascade.common.enumeration.Enumeration]] subtype
   * @param s the String to read
   * @return an Enumeration subtype
   * @throws EnumerationException if no match is made
   */
  @throws[EnumerationException]
  def withName(s: String): T = read(s) match {
    case Some(v) => v
    case None => throw new EnumerationException(s)
  }

}