001/*
002 * ============================================================================
003 * Copyright © 2002-2023 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;
021import static org.tquadrat.foundation.svg.SVGUtils.SVGATTRIBUTE_ExternalResourcesRequired;
022import static org.tquadrat.foundation.svg.SVGUtils.SVGATTRIBUTE_RequiredExtensions;
023import static org.tquadrat.foundation.svg.SVGUtils.SVGATTRIBUTE_RequiredFeatures;
024import static org.tquadrat.foundation.svg.SVGUtils.SVGATTRIBUTE_SystemLanguage;
025
026import java.net.URI;
027import java.util.List;
028import java.util.Locale;
029
030import org.apiguardian.api.API;
031import org.tquadrat.foundation.annotation.ClassVersion;
032
033/**
034 *  SVG elements that allow the conditional processing attributes
035 *  {@value SVGUtils#SVGATTRIBUTE_ExternalResourcesRequired},
036 *  {@value SVGUtils#SVGATTRIBUTE_RequiredExtensions},
037 *  {@value SVGUtils#SVGATTRIBUTE_RequiredFeatures},
038 *  and
039 *  {@value SVGUtils#SVGATTRIBUTE_SystemLanguage}
040 *  will implement this interface.
041 *
042 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
043 *  @version $Id: AllowsConditionalProcessingAttributes.java 1074 2023-10-02 12:05:06Z tquadrat $
044 *  @since 0.0.5
045 *
046 *  @UMLGraph.link
047 */
048@ClassVersion( sourceVersion = "$Id: AllowsConditionalProcessingAttributes.java 1074 2023-10-02 12:05:06Z tquadrat $" )
049@API( status = STABLE, since = "0.0.5" )
050public sealed interface AllowsConditionalProcessingAttributes
051    permits SVG, SVGClipPath, SVGGroup, SVGLine, SVGPath, SVGRectangle, SVGTSpan, SVGText, SVGUse
052{
053        /*------------------------*\
054    ====** Static Initialisations **===========================================
055        \*------------------------*/
056    /**
057     *  The conditional processing attributes.
058     */
059    @SuppressWarnings( "StaticCollection" )
060    public static final List<String> CONDITIONALPROCESSING_ATTRIBUTES = List.of(
061        SVGATTRIBUTE_ExternalResourcesRequired,
062        SVGATTRIBUTE_RequiredExtensions,
063        SVGATTRIBUTE_RequiredFeatures,
064        SVGATTRIBUTE_SystemLanguage
065    );
066
067        /*---------*\
068    ====** Methods **==========================================================
069        \*---------*/
070    /**
071     *  Sets the attribute that indicates the requirement for external
072     *  resources for rendering this SVG element.
073     *
074     *  @param  flag    {@code true} if external resources are needed,
075     *      {@code false} if all required resources are local to the current
076     *      context.
077     */
078    public void setExternalResourcesRequired( final boolean flag );
079
080    /**
081     *  Sets a list of extensions that are required to render this SVG element.
082     *
083     *  @param  values  The URIs that identify the required extensions.
084     */
085    public void setRequiredExtensions( final URI... values );
086
087    /**
088     *  Sets a list of features that are required to render this SVG element.
089     *
090     *  @param  values  The URIs that identify the required features.
091     */
092    public void setRequiredFeatures( final URI... values );
093
094    /**
095     *  Sets a list of languages; the current SVG element will be rendered
096     *  only if the current system language matches one entry of this list.
097     *
098     *  @param  values  The allowed languages.
099     */
100    public void setSystemLanguage( final Locale... values );
101}
102//  interface AllowsConditionalProcessingAttributes
103
104/*
105 *  End of File
106 */