org.apache.xmlbeans.XmlToken Maven / Gradle / Ivy
/* Copyright 2004 The Apache Software Foundation
*
* 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 org.apache.xmlbeans;
import org.apache.xmlbeans.impl.schema.XmlObjectFactory;
/**
* Corresponds to the XML Schema
* xs:token type.
* One of the derived types based on xs:string.
*
* A token is XML's best representation for a "whitespace insensitive string."
* All carriage returns, linefeeds, and tabs are converted to ordinary space
* characters (as with xs:normalizedString),
* and furthermore, all contiguous runs of space are collapsed to single spaces,
* and leading and trailing spaces are trimmed.
*
* If you want {@code " high priority "}
* to be equivalent to {@code "high priority"}, you should consider
* using xs:token or a subtype of xs:token.
*
* When the {@link #getStringValue()} is obtained from an XmlToken, the normalized,
* trimmed, whitespace collapsed value is returned.
*
* Convertible to {@link String}.
*/
public interface XmlToken extends XmlNormalizedString {
XmlObjectFactory Factory = new XmlObjectFactory<>("_BI_token");
/**
* The constant {@link SchemaType} object representing this schema type.
*/
SchemaType type = Factory.getType();
}