View Javadoc

1   /*
2    * Copyright 2010 University Corporation for Advanced Internet Development, Inc.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.opensaml.xml;
18  
19  import javax.xml.namespace.QName;
20  
21  import org.opensaml.xml.util.XMLConstants;
22  
23  /**
24   * Interface for element having a <code>@xml:lang</code> attribute.
25   * 
26   */
27  public interface LangBearing {
28  
29      /** The <code>lang</code> attribute local name. */
30      public static final String XML_LANG_ATTR_LOCAL_NAME = "lang";
31  
32      /** The <code>xml:lang</code> qualified attribute name. */
33      public static final QName XML_LANG_ATTR_NAME =
34          new QName(XMLConstants.XML_NS, XML_LANG_ATTR_LOCAL_NAME, XMLConstants.XML_PREFIX);
35  
36      /**
37       * Returns the <code>@xml:lang</code> attribute value.
38       * 
39       * @return The <code>@xml:lang</code> attribute value or <code>null</code>.
40       */
41      public String getXMLLang();
42  
43      /**
44       * Sets the <code>@xml:lang</code> attribute value.
45       * 
46       * @param newLang The <code>@xml:lang</code> attribute value
47       */
48      public void setXMLLang(String newLang);
49  
50  }