org.apache.xerces.xs.XSNamedMap Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xerces2-xsd11 Show documentation
Show all versions of xerces2-xsd11 Show documentation
A processor for parsing, validating, serializing and manipulating XML, written in Java
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF 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.apache.xerces.xs;
import java.util.Map;
/**
* Objects implementing the XSNamedMap
interface are used to
* represent immutable collections of XML Schema components that can be
* accessed by name. Note that XSNamedMap
does not inherit from
* XSObjectList
. The XSObject
s in
* XSNamedMap
s are not maintained in any particular order.
*/
public interface XSNamedMap extends Map {
/**
* The number of XSObjects
in the XSObjectList
.
* The range of valid child object indices is 0 to length-1
* inclusive.
*/
public int getLength();
/**
* Returns the index
th item in the collection or
* null
if index
is greater than or equal to
* the number of objects in the list. The index starts at 0.
* @param index index into the collection.
* @return The XSObject
at the index
th
* position in the XSObjectList
, or null
if
* the index specified is not valid.
*/
public XSObject item(int index);
/**
* Retrieves an XSObject
specified by local name and
* namespace URI.
*
Per XML Namespaces, applications must use the value null
as the
* namespace
parameter for methods if they wish to specify
* no namespace.
* @param namespace The namespace URI of the XSObject
to
* retrieve, or null
if the XSObject
has no
* namespace.
* @param localName The local name of the XSObject
to
* retrieve.
* @return A XSObject
(of any type) with the specified local
* name and namespace URI, or null
if they do not
* identify any object in this map.
*/
public XSObject itemByName(String namespace,
String localName);
}