001/*
002 * ============================================================================
003 * Copyright © 2002-2020 by Thomas Thrien.
004 * All Rights Reserved.
005 * ============================================================================
006 * Licensed to the public under the agreements of the GNU Lesser General Public
007 * License, version 3.0 (the "License"). You may obtain a copy of the License at
008 *
009 *      http://www.gnu.org/licenses/lgpl.html
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
013 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
014 * License for the specific language governing permissions and limitations
015 * under the License.
016 */
017
018package org.tquadrat.foundation.xml.builder.spi;
019
020import static org.apiguardian.api.API.Status.MAINTAINED;
021
022import java.util.Set;
023
024import org.apiguardian.api.API;
025import org.tquadrat.foundation.annotation.ClassVersion;
026import org.tquadrat.foundation.xml.builder.internal.XMLElementImpl;
027
028/**
029 *  The abstract base class for specialised implementations of
030 *  {@link org.tquadrat.foundation.xml.builder.XMLElement}.
031 *  Because it is derived from
032 *  {@link XMLElementImpl},
033 *  it supports attributes, namespaces, children, text, {@code CDATA} and
034 *  comments.
035 *
036 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
037 *  @version $Id: XMLElementAdapter.java 980 2022-01-06 15:29:19Z tquadrat $
038 *  @since 0.0.5
039 *
040 *  @UMLGraph.link
041 */
042@SuppressWarnings( "AbstractClassExtendsConcreteClass" )
043@ClassVersion( sourceVersion = "$Id: XMLElementAdapter.java 980 2022-01-06 15:29:19Z tquadrat $" )
044@API( status = MAINTAINED, since = "0.0.5" )
045public abstract non-sealed class XMLElementAdapter extends XMLElementImpl
046{
047        /*--------------*\
048    ====** Constructors **=====================================================
049        \*--------------*/
050    /**
051     *  <p>{@summary Creates a new {@code XMLElementAdapter} instance.}</p>
052     *  <p>The given element name is validated using the method that is
053     *  provided by
054     *  {@link org.tquadrat.foundation.xml.builder.XMLBuilderUtils#getElementNameValidator()}.</p>
055     *  <p>The new element allows attributes and children, but will not
056     *  validate them. It also allows text.</p>
057     *
058     *  @param  elementName The element name.
059     */
060    protected XMLElementAdapter( final String elementName ) { super( elementName ); }
061
062    /**
063     *  <p>{@summary Creates a new {@code XMLElementAdapter} instance.}</p>
064     *  <p>The given element name is validated using the method that is
065     *  provided by
066     *  {@link org.tquadrat.foundation.xml.builder.XMLBuilderUtils#getElementNameValidator()}.</p>
067     *
068     *  @note   This constructor is used for the implementation of XML
069     *      specialisations, like SVG or HTML (although this not really XML).
070     *
071     *  @param  elementName The element name.
072     *  @param  flags   The configuration flags for the new element.
073     *
074     *  @see org.tquadrat.foundation.xml.builder.XMLElement.Flags
075     *  @see AttributeSupport#registerAttributes(String...)
076     *  @see AttributeSupport#registerSequence(String...)
077     *  @see ChildSupport#registerChildren(String...)
078     */
079    protected XMLElementAdapter( final String elementName, final Set<Flags> flags )
080    {
081        super( elementName, flags );
082    }   //  XMLElementAdapter()
083}
084//  class XMLElementAdapter
085
086/*
087 *  End of File
088 */