PositiveInteger.java

/**
 * **********************************************************************
 *
 * <p>DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 *
 * <p>Copyright 2008, 2010 Oracle and/or its affiliates. All rights reserved.
 *
 * <p>Use is subject to license terms.
 *
 * <p>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. You can also obtain a copy of the License at
 * http://odftoolkit.org/docs/license.txt
 *
 * <p>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.
 *
 * <p>See the License for the specific language governing permissions and limitations under the
 * License.
 *
 * <p>**********************************************************************
 */
package org.odftoolkit.odfdom.type;

/**
 * This class represents the in OpenDocument format used data type {@odf.datatype positiveInteger}
 */
public class PositiveInteger implements OdfDataType {

  int mN;

  /**
   * Allocates a PositiveInteger object representing the n argument
   *
   * @param n the value of the PositiveInteger
   * @throws NumberFormatException if the given argument is not a valid PostitiveLength
   */
  public PositiveInteger(int n) throws NumberFormatException {
    if (n < 1) {
      throw new NumberFormatException("parameter is invalid for datatype PositiveInteger");
    }
    mN = n;
  }

  /**
   * Returns a String Object representing this PositiveInteger's value
   *
   * @return return a string representation of the value of this PositiveInteger object
   */
  @Override
  public String toString() {
    return Integer.toString(mN);
  }

  /**
   * Returns a PositiveInteger instance representing the specified String value
   *
   * @param stringValue a String value
   * @return return a PositiveInteger instance representing stringValue
   * @throws NumberFormatException if the given argument is not a valid PostitiveLength
   */
  public static PositiveInteger valueOf(String stringValue) throws NumberFormatException {
    String aTmp = stringValue.trim();
    int n = Integer.valueOf(aTmp);
    return new PositiveInteger(n);
  }

  /**
   * Returns the value of this PositiveInteger object as a int primitive
   *
   * @return the primitive int value of this PositiveInteger object.
   */
  public int intValue() {
    return mN;
  }

  /**
   * check if the specified Integer instance is a valid {@odf.datatype positiveInteger} data type
   *
   * @param integerValue the value to be tested
   * @return true if the value of argument is valid for {@odf.datatype positiveInteger} data type
   *     false otherwise
   */
  public static boolean isValid(Integer integerValue) {
    if (integerValue == null) {
      return false;
    }
    if (integerValue.intValue() < 1) {
      return false;
    } else {
      return true;
    }
  }
}