com.sun.xml.xsom.XSComplexType Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2022 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.sun.xml.xsom;
import java.util.List;
/**
* Complex type.
*
* @author
* Kohsuke Kawaguchi ([email protected])
*/
public interface XSComplexType extends XSType, XSAttContainer
{
/**
* Checks if this complex type is declared as an abstract type.
*/
boolean isAbstract();
boolean isFinal(int derivationMethod);
/**
* Roughly corresponds to the block attribute. But see the spec
* for gory detail.
*/
boolean isSubstitutionProhibited(int method);
/**
* Gets the scope of this complex type.
* This is not a property defined in the schema spec.
*
* @return
* null if this complex type is global. Otherwise
* return the element declaration that contains this anonymous
* complex type.
*/
XSElementDecl getScope();
/**
* The content of this complex type.
*
* @return
* always non-null.
*/
XSContentType getContentType();
/**
* Gets the explicit content of a complex type with a complex content
* that was derived by extension.
*
*
* Informally, the "explicit content" is the portion of the
* content model added in this derivation. IOW, it's a delta between
* the base complex type and this complex type.
*
*
* For example, when a complex type T2 derives fom T1, then:
*
* content type of T2 = SEQUENCE( content type of T1, explicit content of T2 )
*
*
* @return
* If this complex type is derived by restriction or has a
* simple content, this method returns null.
* IOW, this method only works for a complex type with
* a complex content derived by extension from another complex type.
*/
XSContentType getExplicitContent();
// meaningful only if getContentType returns particles
boolean isMixed();
/**
* If this is redefined by another complex type,
* return that component.
*
* @return null
* if this component has not been redefined.
*/
XSComplexType getRedefinedBy();
/**
* Returns a list of direct subtypes of this complex type. If the type is not subtyped, returns empty list.
* Doesn't return null.
* Note that the complex type may be extended outside of the scope of the schemaset known to XSOM.
*/
List getSubtypes();
/**
* Returns a list of element declarations of this type.
*/
List getElementDecls();
}