Varbind.java

/*******************************************************************************
 * This file is part of OpenNMS(R).
 *
 * Copyright (C) 2009-2012 The OpenNMS Group, Inc.
 * OpenNMS(R) is Copyright (C) 1999-2012 The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * OpenNMS(R) is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with OpenNMS(R).  If not, see:
 *      http://www.gnu.org/licenses/
 *
 * For more information contact:
 *     OpenNMS(R) Licensing <license@opennms.org>
 *     http://www.opennms.org/
 *     http://www.opennms.com/
 *******************************************************************************/

package org.opennms.netmgt.xml.eventconf;

import java.io.IOException;
import java.io.Reader;
import java.io.Serializable;
import java.io.Writer;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.List;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;

import org.exolab.castor.xml.MarshalException;
import org.exolab.castor.xml.Marshaller;
import org.exolab.castor.xml.Unmarshaller;
import org.exolab.castor.xml.ValidationException;
import org.exolab.castor.xml.Validator;
import org.opennms.core.xml.ValidateUsing;
import org.xml.sax.ContentHandler;

@XmlRootElement(name="varbind")
@XmlAccessorType(XmlAccessType.FIELD)
@ValidateUsing("eventconf.xsd")
@XmlType(propOrder={"m_vbnumber", "m_values"})
public class Varbind implements Serializable {
	private static final long serialVersionUID = 2387062723322720364L;

	private static final String[] EMPTY_STRING_ARRAY = new String[0];

    @XmlAttribute(name="textual-convention", required=false)
    private String m_textualConvention;

    // @NotNull
	@XmlElement(name="vbnumber", required=true)
    private Integer m_vbnumber;

	// @Size(min=1)
	// @NotNull
	@XmlElement(name="vbvalue", required=true)
    private List<String> m_values = new ArrayList<String>();

    public String getTextualConvention() {
        return m_textualConvention;
    }

    public void setTextualConvention(final String textualConvention) {
        m_textualConvention = textualConvention == null? null : textualConvention.intern();
    }

    public Integer getVbnumber() {
        return m_vbnumber;
    }

    public void setVbnumber(final Integer vbnumber) {
        m_vbnumber = vbnumber;
    }

    public void deleteVbnumber() {
        m_vbnumber = null;
    }

    public boolean hasVbnumber() {
        return m_vbnumber != null;
    }

    public String getVbvalue(final int index) throws IndexOutOfBoundsException {
        return m_values.get(index);
    }

    public String[] getVbvalue() {
		return m_values.toArray(EMPTY_STRING_ARRAY);
    }

    public List<String> getVbvalueCollection() {
        return m_values;
    }

    public int getVbvalueCount() {
        return m_values.size();
    }

    public void setVbvalue(final int index, final String value) throws IndexOutOfBoundsException {
        m_values.set(index, value == null? null : value.intern());
    }

    public void setVbvalue(final String[] values) {
        m_values.clear();
        for (final String value : values) {
        	m_values.add(value == null? null : value.intern());
        }
    }

    public void setVbvalue(final List<String> values) {
        m_values.clear();
        for (final String value : values) {
        	m_values.add(value == null? null : value.intern());
        }
    }

    public void setVbvalueCollection(final List<String> values) {
    	setVbvalue(values);
    }

    public void addVbvalue(final String value) throws IndexOutOfBoundsException {
        m_values.add(value == null? null : value.intern());
    }

    public void addVbvalue(final int index, final String value) throws IndexOutOfBoundsException {
        m_values.add(index, value == null? null : value.intern());
    }

    public void removeAllVbvalue() {
        m_values.clear();
    }

    public boolean removeVbvalue(final String value) {
        return m_values.remove(value);
    }

    public String removeVbvalueAt(final int index) {
        return m_values.remove(index);
    }

    public Enumeration<String> enumerateVbvalue() {
        return Collections.enumeration(m_values);
    }

    public Iterator<String> iterateVbvalue() {
        return m_values.iterator();
    }

    public boolean isValid() {
        try {
            validate();
        } catch (final ValidationException vex) {
            return false;
        }
        return true;
    }

    public void marshal(final Writer out) throws MarshalException, ValidationException {
        Marshaller.marshal(this, out);
    }

    public void marshal(final ContentHandler handler) throws IOException, MarshalException, ValidationException {
        Marshaller.marshal(this, handler);
    }

    public static Varbind unmarshal(final Reader reader) throws MarshalException, ValidationException {
        return (Varbind) Unmarshaller.unmarshal(Varbind.class, reader);
    }

    public void validate() throws ValidationException {
        new Validator().validate(this);
    }

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + ((m_textualConvention == null) ? 0 : m_textualConvention.hashCode());
		result = prime * result + ((m_values == null) ? 0 : m_values.hashCode());
		result = prime * result + ((m_vbnumber == null) ? 0 : m_vbnumber.hashCode());
		return result;
	}

	@Override
	public boolean equals(final Object obj) {
		if (this == obj) return true;
		if (obj == null) return false;
		if (!(obj instanceof Varbind)) return false;
		final Varbind other = (Varbind) obj;
		if (m_textualConvention == null) {
			if (other.m_textualConvention != null) return false;
		} else if (!m_textualConvention.equals(other.m_textualConvention)) {
			return false;
		}
		if (m_values == null) {
			if (other.m_values != null) return false;
		} else if (!m_values.equals(other.m_values)) {
			return false;
		}
		if (m_vbnumber == null) {
			if (other.m_vbnumber != null) return false;
		} else if (!m_vbnumber.equals(other.m_vbnumber)) {
			return false;
		}
		return true;
	}

}