org.jvnet.fastinfoset.Vocabulary Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webservices-rt Show documentation
This module contains the Metro runtime code.
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2004, 2023 Oracle and/or its affiliates. All rights reserved.
 *
 * Oracle 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
 *
 *      https://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.jvnet.fastinfoset;

import java.util.LinkedHashSet;
import java.util.Set;
import javax.xml.namespace.QName;

/**
 * A canonical representation of a vocabulary.
 * 
 * Each vocabulary table is represented as a Set. A vocabulary table entry is
 * represented as an item in the Set.
 * 

 * The 1st item contained in a Set is assigned the smallest index value,
 * n say (where n {@literal >}= 0). The 2nd item is assigned an index value of n + 1. The kth
 * item is assigned an index value of n + (k - 1).
 * 
 * A Fast Infoset parser/serializer implementation will tranform the canonical
 * representation of a Vocabulary instance into a more optimal form suitable
 * for the efficient usage according to the API implemented by the parsers and
 * serializers.
 */
public class Vocabulary {
    /**
     * The restricted alphabet table, containing String objects.
     */
    public final Set restrictedAlphabets = new LinkedHashSet<>();

    /**
     * The encoding algorithm table, containing String objects.
     */
    public final Set encodingAlgorithms = new LinkedHashSet<>();

    /**
     * The prefix table, containing String objects.
     */
    public final Set prefixes = new LinkedHashSet<>();

    /**
     * The namespace name table, containing String objects.
     */
    public final Set namespaceNames = new LinkedHashSet<>();

    /**
     * The local name table, containing String objects.
     */
    public final Set localNames = new LinkedHashSet<>();

    /**
     * The "other NCName" table, containing String objects.
     */
    public final Set otherNCNames = new LinkedHashSet<>();

    /**
     * The "other URI" table, containing String objects.
     */
    public final Set otherURIs = new LinkedHashSet<>();

    /**
     * The "attribute value" table, containing String objects.
     */
    public final Set attributeValues = new LinkedHashSet<>();

    /**
     * The "other string" table, containing String objects.
     */
    public final Set otherStrings = new LinkedHashSet<>();

    /**
     * The "character content chunk" table, containing String objects.
     */
    public final Set characterContentChunks = new LinkedHashSet<>();

    /**
     * The element table, containing QName objects.
     */
    public final Set elements = new LinkedHashSet<>();

    /**
     * The attribute table, containing QName objects.
     */
    public final Set attributes = new LinkedHashSet<>();

    public Vocabulary() {
    }
}