de.micromata.opengis.kml.v_2_2_0.atom.Author Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of JavaAPIforKml Show documentation

This is JavaAPIforKMml, Micromata's library for use with applications that want to parse, generate and operate on KML. It is an implementation of the OGC KML 2.2 standard. It is written entirely in Java and makes heavy use of JAXB.

There is a newer version: 3.0.4

Show newest version


package de.micromata.opengis.kml.v_2_2_0.atom;

import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlRootElement;
import jakarta.xml.bind.annotation.XmlType;

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


/**
 * 
 * KML 2.2 supports new elements for including data about the author and related website 
 * in your KML file. This information is displayed in geo search results, both in Earth 
 * browsers such as Google Earth, and in other applications such as Google Maps. The 
 * ascription elements used in KML are as follows: 
 * 
 * 
 * The {@code } element is the parent element for {@code }, which specifies
 * the author of the KML feature. 
 * 
 * 
 * These elements are defined in the Atom Syndication Format. The complete specification 
 * is found at http://atompub.org. (see the sample that follows). 
 * 
 * 
 * These elements are defined in the Atom Syndication Format. The complete specification 
 * is found at http://atompub.org. (see the sample that follows). 
 * 
 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = {
    "nameOrUriOrEmail"
})
@XmlRootElement(name = "author")
public class Author implements Cloneable
{

    protected List nameOrUriOrEmail;

    public Author() {
        super();
    }

    public List getNameOrUriOrEmail() {
        if (nameOrUriOrEmail == null) {
            nameOrUriOrEmail = new ArrayList();
        }
        return this.nameOrUriOrEmail;
    }

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

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if ((obj instanceof Author) == false) {
            return false;
        }
        Author other = ((Author) obj);
        if (nameOrUriOrEmail == null) {
            if (other.nameOrUriOrEmail!= null) {
                return false;
            }
        } else {
            if (nameOrUriOrEmail.equals(other.nameOrUriOrEmail) == false) {
                return false;
            }
        }
        return true;
    }

    public void setNameOrUriOrEmail(final List nameOrUriOrEmail) {
        this.nameOrUriOrEmail = nameOrUriOrEmail;
    }

    /**
     * add a value to the nameOrUriOrEmail property collection
     * 
     * @param nameOrUriOrEmail
     *     Objects of the following type are allowed in the list: {@code <}{@link String}{@code >}{@code <}{@link String}{@code >}{@code <}{@link String}{@code >}
     * @return
     *     true (as general contract of Collection.add). 
     */
    public Author addToNameOrUriOrEmail(final String nameOrUriOrEmail) {
        this.getNameOrUriOrEmail().add(nameOrUriOrEmail);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param nameOrUriOrEmail
     *     required parameter
     */
    public Author withNameOrUriOrEmail(final List nameOrUriOrEmail) {
        this.setNameOrUriOrEmail(nameOrUriOrEmail);
        return this;
    }

    @Override
    public Author clone() {
        Author copy;
        try {
            copy = ((Author) super.clone());
        } catch (CloneNotSupportedException _x) {
            throw new InternalError((_x.toString()));
        }
        copy.nameOrUriOrEmail = new ArrayList((getNameOrUriOrEmail().size()));
        for (String iter: nameOrUriOrEmail) {
            copy.nameOrUriOrEmail.add(iter);
        }
        return copy;
    }

}