opennlp-coref/src/main/java/opennlp/tools/coref/sim/NumberEnum.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 opennlp.tools.coref.sim;

/**
 * Enumeration of number types.
 */
public class NumberEnum {

  private final String name;
  
  /** 
   * Singular number type. 
   */
  public static final NumberEnum SINGULAR = new NumberEnum("singular");
  
  /** 
   * Plural number type. 
   */
  public static final NumberEnum PLURAL = new NumberEnum("plural");
  
  /** 
   * Unknown number type. 
   */
  public static final NumberEnum UNKNOWN = new NumberEnum("unknown");

  private NumberEnum(String name) {
    this.name = name;
  }

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