com.tectonica.jonix.common.OnixComposite Maven / Gradle / Ivy
/*
* Copyright (C) 2012-2023 Zach Melamed
*
* Latest version available online at https://github.com/zach-m/jonix
* Contact me at [email protected]
*
* 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 com.tectonica.jonix.common;
/**
* Fundamental interface in {@link com.tectonica.jonix.common Jonix object model}, representing an ONIX Composite (i.e.
* a container for ONIX Elements and possibly other ONIX Composites)
*/
public interface OnixComposite extends OnixTag {
/**
* This is an internal API. Since Jonix 8.0, composite objects are being populated lazily. This method initiates the
* population process, and is invoked internally by the accessor APIs of the composites
*/
void _initialize();
/**
* For advanced use-cases only.
*
* @return native representation of the XML element underlying to this tag
*/
org.w3c.dom.Element getXmlElement();
/**
* Fundamental interface in {@link com.tectonica.jonix.common Jonix object model}, representing an ONIX Composite
* that contains other composites
*/
interface OnixSuperComposite extends OnixComposite {
}
/**
* Fundamental interface in {@link com.tectonica.jonix.common Jonix object model}, representing an ONIX Composite
* that contains only ONIX Elements (i.e. no nested composites). This composite is unique to specific version of
* ONIX, and isn't common to all.
*/
interface OnixDataCompositeUncommon extends OnixComposite {
}
/**
* Fundamental interface in {@link com.tectonica.jonix.common Jonix object model}, representing an ONIX Composite
* that contains only ONIX Elements (i.e. no nested composites)
*/
interface OnixDataComposite extends OnixComposite {
V asStruct();
}
/**
* Fundamental interface in {@link com.tectonica.jonix.common Jonix object model}, representing an ONIX Composite
* that contains only ONIX Elements (i.e. no nested composites), one of which is the key of the composite (i.e. a
* mandatory, unique, enumerated code-list, by which a composite can be looked up)
*/
interface OnixDataCompositeWithKey, K extends Enum & OnixCodelist>
extends OnixDataComposite {
K structKey();
}
}