org.odftoolkit.odfdom.type.NCName Maven / Gradle / Ivy

/**
 * **********************************************************************
 *
 * 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 org.odftoolkit.odfdom.type;

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

  private String mName;

  /**
   * Construct NCName by the parsing the given string
   *
   * @param name The String to be parsed into NCName
   * @throws IllegalArgumentException if the given argument is not a valid NCName
   */
  public NCName(String name) throws IllegalArgumentException {
    if (name == null) {
      throw new IllegalArgumentException("parameter can not be null for NCName");
    }
    // validate 'NCName' type which is defined in W3C schema
    // http://www.w3.org/TR/xmlschema-2/#NCName
    if (!W3CSchemaType.isValid("NCName", name)) {
      throw new IllegalArgumentException("parameter is invalid for datatype NCName");
    }
    mName = name;
  }

  /**
   * Returns a String Object representing this NCName value
   *
   * @return return a string representation of the value of this NCName object
   */
  @Override
  public String toString() {
    return mName;
  }

  /**
   * Returns a NCName instance representing the specified String value
   *
   * @param stringValue a String value
   * @return return a NCName instance representing stringValue
   * @throws IllegalArgumentException if the given argument is not a valid NCName
   */
  public static NCName valueOf(String stringValue) throws IllegalArgumentException {
    return new NCName(stringValue);
  }

  /**
   * check if the specified String instance is a valid {@odf.datatype NCName} data type
   *
   * @param stringValue the value to be tested
   * @return true if the value of argument is valid for {@odf.datatype NCName} data type false
   *     otherwise
   */
  public static boolean isValid(String stringValue) {
    if (stringValue == null) {
      return true;
    } else {
      return W3CSchemaType.isValid("NCName", stringValue);
    }
  }
}