org.apache.woden.xml.QNameListOrTokenAttr Maven / Gradle / Ivy

/**
 * 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.woden.xml;

import javax.xml.namespace.QName;

/**
 * This interface represents XML attribute information items of type 
 * 'Union of list of xs:QName or xs:token', for example
 * the wsoap:subcodes extension attribute of binding <fault>.
 * 
 * The isQNameList method can be used to determine whether
 * to call the getQNames method or the getToken
 * method. If the implementor object is initialized with a list of QNames,
 * isQNameList will return 'true', getQNames
 * will return an array of QName objects and getToken will return
 * null. If it is initialized with a xs:token, isQNameList will 
 * return 'false', getQNames will return null and 
 * getToken will return the token string.
 * 
 * If the implementor object is initialized with a null value (i.e. because
 * of an attribute value conversion error or because the attribute value
 * was empty in the WSDL),  the getContents, 
 * getQNameList and getToken methods will return null 
 * and isQNameList and isValid will return false.
 * 
 * @author [email protected]
 */
public interface QNameListOrTokenAttr extends XMLAttr 
{
    public boolean isQNameList();
    
    public boolean isToken();
    
    public QName[] getQNames();
    
    public String getToken();
}