/*
* reserved comment block
* DO NOT REMOVE OR ALTER!
*/
/*
* 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 com.sun.org.apache.xerces.internal.xs;
/**
* This interface represents a complex or simple type definition.
*/
public interface XSTypeDefinition extends XSObject {
/**
* The object describes a complex type.
*/
public static final short COMPLEX_TYPE = 15;
/**
* The object describes a simple type.
*/
public static final short SIMPLE_TYPE = 16;
/**
* Return whether this type definition is a simple type or complex type.
*/
public short getTypeCategory();
/**
* {base type definition}: either a simple type definition or a complex
* type definition.
*/
public XSTypeDefinition getBaseType();
/**
* {final}. For a complex type definition it is a subset of {extension,
* restriction}. For a simple type definition it is a subset of
* {extension, list, restriction, union}.
* @param restriction Extension, restriction, list, union constants
* (defined in XSConstants
).
* @return True if restriction
is in the final set,
* otherwise false.
*/
public boolean isFinal(short restriction);
/**
* For complex types the returned value is a bit combination of the subset
* of {DERIVATION_EXTENSION, DERIVATION_RESTRICTION
}
* corresponding to final
set of this type or
* DERIVATION_NONE
. For simple types the returned value is
* a bit combination of the subset of {
* DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION, DERIVATION_LIST
* } corresponding to final
set of this type or
* DERIVATION_NONE
.
*/
public short getFinal();
/**
* Convenience attribute. A boolean that specifies if the type definition
* is anonymous.
*/
public boolean getAnonymous();
/**
* Convenience method which checks if this type is derived from the given
* ancestorType
.
* @param ancestorType An ancestor type definition.
* @param derivationMethod A bit combination representing a subset of {
* DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION, DERIVATION_LIST
* }.
* @return True if this type is derived from ancestorType
* using only derivation methods from the derivationMethod
* .
*/
public boolean derivedFromType(XSTypeDefinition ancestorType,
short derivationMethod);
/**
* Convenience method which checks if this type is derived from the given
* ancestor type.
* @param namespace An ancestor type namespace.
* @param name An ancestor type name.
* @param derivationMethod A bit combination representing a subset of {
* DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION, DERIVATION_LIST
* }.
* @return True if this type is derived from ancestorType
* using only derivation methods from the derivationMethod
* .
*/
public boolean derivedFrom(String namespace,
String name,
short derivationMethod);
}