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.svg;
019
020import static org.apiguardian.api.API.Status.STABLE;
021
022import org.apiguardian.api.API;
023import org.tquadrat.foundation.annotation.ClassVersion;
024
025/**
026 *  The definition of an SVG element that allows child elements.
027 *
028 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
029 *  @version $Id: SVGElementWithChildren.java 820 2020-12-29 20:34:22Z tquadrat $
030 *  @since 0.0.5
031 *
032 *  @UMLGraph.link
033 */
034@ClassVersion( sourceVersion = "$Id: SVGElementWithChildren.java 820 2020-12-29 20:34:22Z tquadrat $" )
035@API( status = STABLE, since = "0.0.5" )
036public sealed interface SVGElementWithChildren extends SVGElement
037    permits SVG, SVGClipPath, SVGGroup, SVGLine, SVGMarker, SVGPath, SVGRectangle, SVGSymbol, SVGTSpan, SVGText
038{
039        /*---------*\
040    ====** Methods **==========================================================
041        \*---------*/
042    /**
043     *  Adds a child to this element.
044     *
045     *  @param  <E> The implementation type for the {@code children}.
046     *  @param  child   The child to add.
047     *  @throws IllegalArgumentException    The given child is not valid for
048     *      this element or no children are allowed at all.
049     *  @throws IllegalStateException   The child has already a parent that is
050     *      not this element.
051     */
052    public <E extends SVGElement> void addChild( final E child ) throws IllegalArgumentException, IllegalStateException;
053
054    /**
055     *  Sets the description for the SVG element.<br>
056     *  <br>This is not an attribute, instead a
057     *  <code>&lt;{@value SVGUtils#SVGELEMENT_Description}&gt;</code> element
058     *  will be added as a child.
059     *
060     *  @param  description The description.
061     */
062    public void setDescription( final CharSequence description );
063}
064//  interface SVGElementWithChildren
065
066/*
067 *  End of File
068 */