trunk/odfdom/src/main/java/org/odftoolkit/odfdom/type/LanguageCode.java

/************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 * 
 * Copyright 2008, 2010 Oracle and/or its affiliates. All rights reserved.
 * 
 * Use is subject to license terms.
 * 
 * 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
 * 
 * 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;

import java.util.regex.Pattern;

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

	private String mLanguageCode;
	private static final Pattern languageCodePattern = Pattern.compile("^[A-Za-z]{1,8}$");
	
	/**
	 * Construct LanguageCode by the parsing the given string
	 *
	 * @param languageCode The String to be parsed into LanguageCode
	 * @throws IllegalArgumentException if the given argument is not a valid langageCode
	 */
	public LanguageCode(String languageCode) throws IllegalArgumentException {
		if (!isValid(languageCode)) {
			throw new IllegalArgumentException(
					"parameter is invalid for datatype LanguageCode");
		}

		// validate 'LanguageCode' type which is defined in W3C schema
		// http://www.w3.org/TR/xmlschema-2/#token
		if (!W3CSchemaType.isValid("token", languageCode)) {
			throw new IllegalArgumentException(
					"parameter is invalid for datatype LanguageCode");
		}
		mLanguageCode = languageCode;
	}

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

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

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