Package com.google.template.soy.msgs.restricted

Source Code of com.google.template.soy.msgs.restricted.SoyMsgPluralCaseSpec

/*
* Copyright 2011 Google Inc.
*
* 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.google.template.soy.msgs.restricted;

import com.google.template.soy.msgs.SoyMsgException;

import java.util.EnumMap;
import java.util.EnumSet;
import java.util.Locale;


/**
* Represents a plural case value.
*
* A plural case value can be either a number, or one of {@code ZERO}, {@code ONE}, {@code TWO},
* {@code FEW}, {@code MANY} or {@code OTHER}.  Here, a number is represented by the number
* {@code explicitValue} with status set to EXPLICIT and the remaining by an enum value.
*
* @author Umesh Nair
*/
public class SoyMsgPluralCaseSpec {

  /** The type.  EXPLICIT indicating numeric, or one of the others indicating non-numeric. */
  public enum Type { EXPLICIT, ZERO, ONE, TWO, FEW, MANY, OTHER }

  /** Internal mapping of Type to String, reduces memory usage */
  private static final EnumMap<Type, String> TYPE_TO_STRING = new EnumMap<Type, String>(Type.class);
  static {
    for (Type t : EnumSet.allOf(Type.class)) {
      TYPE_TO_STRING.put(t, t.name().toLowerCase(Locale.ENGLISH));
    }
  }

  /** ZERO, ONE, TWO, FEW, MANY or OTHER if the type is non-numeric, or EXPLICIT if numeric. */
  private final Type type;

  /** The numeric value if the type is numeric, -1 otherwise. */
  private final int explicitValue;


  /**
   * Constructs an object from a non-numeric value.
   * The field type is set to an enum value corresponding to the string given, and explicitValue
   * is set to -1.
   * @param typeStr String representation of the non-numeric value.
   * @throws IllegalArgumentException if typeStr (after converting to upper
   *     case) does not match with any of the enum types.
   */
  public SoyMsgPluralCaseSpec(String typeStr) {
    type = Type.valueOf(typeStr.toUpperCase(Locale.ENGLISH));
    explicitValue = -1;
  }


  /**
   * Constructs an object from a numeric value.
   * The field type is set to EXPLICIT, and explicitValue is set to the numeric value given.
   * @param explicitValue The numeric value.
   * @throws SoyMsgException if invalid numeric value.
   */
  public SoyMsgPluralCaseSpec(int explicitValue) {
    if (explicitValue >= 0) {
      type = Type.EXPLICIT;
      this.explicitValue = explicitValue;
    } else {
      throw new SoyMsgException("Negative plural case value.");
    }
  }


  /**
   * Get the type.
   * @return The type.  EXPLICIT if numeric.
   */
  public Type getType() {
    return type;
  }


  /**
   * Get the numeric value.
   * @return if numeric, return the numeric value, else -1.
   */
  public int getExplicitValue() {
    return explicitValue;
  }

  @Override
  public String toString() {
    return (type == Type.EXPLICIT) ? "=" + explicitValue : TYPE_TO_STRING.get(type);
  }
}
TOP

Related Classes of com.google.template.soy.msgs.restricted.SoyMsgPluralCaseSpec

TOP
Copyright © 2018 www.massapi.com. All rights reserved.
All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.