net.sf.jsefa.xml.mapping.AttributeDescriptor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsefa-android Show documentation

JSefa (Java Simple exchange format api) is a simple library for stream-based serialization of java objects to XML, CSV, FLR or any other format and back again using an iterator-style interface independent of the serialization format. The mapping between java object types and types of the serialization format (e. g. xml complex element types) can be defined either by annotating the java classes or programmatically using a simple API. The current implementation supports XML, CSV and FLR - for XML it is based on JSR 173.

The newest version!

/*
 * Copyright 2007 the original author or authors.
 *
 * 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 net.sf.jsefa.xml.mapping;

import net.sf.jsefa.xml.namespace.QName;

/**
 * Descriptor for an xml attribute.
 * 
 * Instances of this class are immutable and thread safe.
 * 
 * @author Norman Lahme-Huetig
 * 
 */
public final class AttributeDescriptor implements XmlNodeDescriptor {

    private final QName name;

    private final int hashCode;

    /**
     * Constructs a new AttributeDescriptor.
     * 
     * @param name the name of the attribute
     */
    public AttributeDescriptor(QName name) {
        this.name = name;
        this.hashCode = calculateHashCode();
    }

    /**
     * {@inheritDoc}
     */
    public XmlNodeType getType() {
        return XmlNodeType.ATTRIBUTE;
    }

    /**
     * Returns the name of the attribute.
     * 
     * @return the attribute name
     */
    public QName getName() {
        return this.name;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int hashCode() {
        return this.hashCode;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (!(obj instanceof AttributeDescriptor)) {
            return false;
        }
        final AttributeDescriptor other = (AttributeDescriptor) obj;
        return name.equals(other.name);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
        return getName().toString();
    }

    private int calculateHashCode() {
        return name.hashCode();
    }

}