org.opensaml.xml.IdBearing Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xmltooling Show documentation

XMLTooling-J is a low-level library that may be used to construct libraries that allow developers to work with XML in a Java beans manner.

There is a newer version: 1.4.4

Show newest version

/*
 * Licensed to the University Corporation for Advanced Internet Development, 
 * Inc. (UCAID) under one or more contributor license agreements.  See the 
 * NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The UCAID licenses this file to You 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 org.opensaml.xml;

import javax.xml.namespace.QName;

import org.opensaml.xml.util.XMLConstants;

/**
 * Interface for element having a @xml:id attribute.
 * 
 */
public interface IdBearing {

    /** The id attribute local name. */
    public static final String XML_ID_ATTR_LOCAL_NAME = "id";

    /** The xml:id qualified attribute name. */
    public static final QName XML_ID_ATTR_NAME =
        new QName(XMLConstants.XML_NS, XML_ID_ATTR_LOCAL_NAME, XMLConstants.XML_PREFIX);

    /**
     * Returns the @xml:id attribute value.
     * 
     * @return The @xml:id attribute value or null.
     */
    public String getXMLId();

    /**
     * Sets the @xml:id attribute value.
     * 
     * @param newId The @xml:id attribute value
     */
    public void setXMLId(String newId);

}