OrderingOrderingDescriptor.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2013 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package org.glassfish.web.deployment.descriptor;

import java.util.Set;
import java.util.TreeSet;

import com.sun.enterprise.util.LocalStringManagerImpl;
import org.glassfish.deployment.common.Descriptor;

/**
 * This represents the ordering-ordering in web-fragment.xml.
 *
 * @author Shing Wai Chan
 */
public class OrderingOrderingDescriptor extends Descriptor {
    private static LocalStringManagerImpl localStrings =
            new LocalStringManagerImpl(OrderingOrderingDescriptor.class);

    private Set<String> names = new TreeSet<String>();
    private boolean others = false;

    public void addName(String name) {
        if (name == null || name.length() == 0) {
            throw new IllegalStateException(localStrings.getLocalString(
                    "web.deployment.exceptioninvalidnameinrelativeordering",
                    "The empty name is invalid for relative ordering element."));
        }
        names.add(name);
    }

    public void addOthers() {
        others = true;
    }

    public Set<String> getNames() {
        return names;
    }

    public boolean containsOthers() {
        return others;
    }

    public boolean containsName(String name) {
        return names.contains(name);
    }

    public String toString() {
        StringBuilder builder = new StringBuilder("[");
        boolean first = true;
        for (String n : names) {
            if (!first) {
                builder.append(", ");
            }
            builder.append(n);
            first = false;
        }

        if (others) {
            if (!first) {
                builder.append(", ");
            }
            builder.append("<others/>");
        }
        builder.append("]");
        return builder.toString();
    }
}