jakarta.faces.view.facelets.Tag Maven / Gradle / Ivy

/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 * Copyright 2005-2007 The Apache Software Foundation
 *
 * 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 jakarta.faces.view.facelets;

import jakarta.faces.view.Location;

/**
 * 
 * The runtime must create an instance of this class for each element in the Facelets XHTML view. A {@link TagConfig}
 * subinterface instance is responsible for providing an instance of Tag to the {@link TagHandler} instance
 * that is passed the TagConfig in its constructor.
 * 
 *
 * @since 2.0
 */
public final class Tag {

    /**
     * Stores the tag attributes.
     */
    private final TagAttributes attributes;

    /**
     * Stores the location.
     */
    private final Location location;

    /**
     * Stores the XML namespace.
     */
    private final String namespace;

    /**
     * Stores the XML local name.
     */
    private final String localName;

    /**
     * Stores the XML qualified name.
     */
    private final String qName;

    /**
     * Constructor.
     *
     * @param location the location.
     * @param namespace the XML namespace.
     * @param localName the XML local name.
     * @param qName the XML qualified name.
     * @param attributes the tag attributes.
     */
    public Tag(Location location, String namespace, String localName, String qName, TagAttributes attributes) {
        this.location = location;
        this.namespace = namespace;
        this.localName = localName;
        this.qName = qName;
        this.attributes = attributes;
    }

    /**
     * Constructor.
     *
     * @param orig the original tag.
     * @param attributes the tag attributes.
     */
    public Tag(Tag orig, TagAttributes attributes) {
        this(orig.getLocation(), orig.getNamespace(), orig.getLocalName(), orig.getQName(), attributes);
    }

    /**
     * 
     * Return an object encapsulating the {@link TagAttributes} specified on this element in the view.
     * 
     *
     * @return the {@link TagAttributes}.
     */
    public TagAttributes getAttributes() {
        return attributes;
    }

    /**
     * 
     * Return the XML local name of the tag. For example, <my:tag /> would be "tag".
     * 
     *
     * @return the XML local name.
     */
    public String getLocalName() {
        return localName;
    }

    /**
     * 
     * Return the Location of this Tag instance in the Facelet view.
     * 
     *
     * @return the Location.
     */
    public Location getLocation() {
        return location;
    }

    /**
     * 
     * Return the resolved XML Namespace for this tag in the Facelets view.
     * 
     *
     * @return the XML namespace.
     */
    public String getNamespace() {
        return namespace;
    }

    /**
     * 
     * Return the XML qualified name for this tag. For example, <my:tag /> would be "my:tag".
     *
     * @return the XML qualified name.
     */
    public String getQName() {
        return qName;
    }

    /**
     * Get the string representation.
     *
     * @return the string representation.
     */
    @Override
    public String toString() {
        return location + " <" + qName + ">";
    }
}