com.cisco.oss.foundation.configuration.xml.Namespace Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of configuration-api Show documentation
This project is the api library for configuration in the cisco vss foundation runtime
There is a newer version: 1.1.0-1
/*
 * Copyright 2014 Cisco Systems, Inc.
 *
 *  Licensed 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 com.cisco.oss.foundation.configuration.xml;

import com.cisco.oss.foundation.configuration.xml.jaxb.NamespaceDefinition;
import com.cisco.oss.foundation.configuration.xml.jaxb.NamespaceDependency;
import com.cisco.oss.foundation.configuration.xml.jaxb.NamespaceIdentifier;

import java.util.ArrayList;
import java.util.List;

public class Namespace {
    private NamespaceDefinition namespaceDef = null;
    private String id = null;
    private List directDependencyIds = null;

    public Namespace(NamespaceDefinition def) throws XmlException {
        if(def == null) {
            throw new XmlException("The given NamespaceDefinition was null");
        }
        id = getNamespaceToken(def.getNamespaceIdentifier());
        directDependencyIds = createDirectDependencyIdList(id, def);
        namespaceDef = def;
    }

    public final String getId() {
        return(id);
    }
    public final NamespaceDefinition getNamespaceDefinition() {
        return(namespaceDef);
    }
    public final List getDirectDependencyIds() {
        return(directDependencyIds);
    }

    @Override
    public boolean equals(Object e) {
        try {
            return(getId().equals(((Namespace)e).getId()));
        } catch(Throwable t) {
            return(false);
        }
    }

    private List createDirectDependencyIdList(String id, NamespaceDefinition def) throws XmlException {

        if(def == null) {
            throw new XmlException("Cannot create Direct Dependency Id List from null");
        }

        ArrayList dependencies = new ArrayList();

        List deps = def.getNamespaceDependencies();
        if( (deps != null) && (!deps.isEmpty()) ) {
            for(NamespaceDependency dep: deps) {
                String token = getNamespaceToken(dep.getNamespaceIdentifier());
                if(dependencies.contains(token)) {
                    throw new XmlException("Duplicate dependency found in " + id + ": " + token);
                }
                if(id.equals(token)) {
                    throw new XmlException("Namespace, " + id + ", depends on itself");
                }
                dependencies.add(token);
            }
        }

        return(dependencies);
    }
    private String getNamespaceToken(NamespaceIdentifier namespaceId) throws XmlException {
        if(namespaceId == null) {
            throw new XmlException("The given namespace has no NamespaceIdentifier");
        }
        String name = namespaceId.getName();
        String version = namespaceId.getVersion();

        if( (name==null) || (name.trim().length() == 0) ) {
            throw new XmlException("The given namespace has no NamespaceIdentifier.name");
        }
        if( (version==null) || (version.trim().length() == 0) ) {
            throw new XmlException("The given namespace has no NamespaceIdentifier.version");
        }
        return("[" + name.trim() + "].[" + version.trim() + "]");
    }
    @Override
    public String toString() {
        return(getId() + ": " + getDirectDependencyIds());
    }
}