de.micromata.opengis.kml.v_2_2_0.gx.Tour 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.gx;

import de.micromata.opengis.kml.v_2_2_0.*;
import de.micromata.opengis.kml.v_2_2_0.annotations.Obvious;
import de.micromata.opengis.kml.v_2_2_0.atom.Author;
import de.micromata.opengis.kml.v_2_2_0.atom.Link;
import de.micromata.opengis.kml.v_2_2_0.xal.AddressDetails;
import jakarta.xml.bind.annotation.*;

import java.util.List;


/**
 * {@code }
 * 
 * {@code } can contain a single {@code } element, which in turn contains an
 * ordered list of gx:TourPrimitive elements that define a tour in any KML browser. 
 * Learn more about tours. 
 * 
 * 
 * Syntax: 
 * <gx:Tour>
 *   <name>...</name>
 *   <description>...</description>
 *   <gx:Playlist>
 * 
 *     <!-- any number of gx:TourPrimitive elements -->
 * 
 *   </gx:Playlist>
 * </gx:Tour>
 * 
 * Contains: 
 *
 *
 *
 *
 *
 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "TourType", propOrder = {
    "playlist"
})
@XmlRootElement(name = "Tour", namespace = "http://www.google.com/kml/ext/2.2")
public class Tour
    extends Feature
    implements Cloneable
{

    @XmlElement(name = "Playlist")
    protected Playlist playlist;

    public Tour() {
        super();
    }

    /**
     *
     * 
     * @return
     *     possible object is
     *     {@link Playlist}
     *     
     */
    public Playlist getPlaylist() {
        return playlist;
    }

    /**
     *
     * 
     * @param value
     *     allowed object is
     *     {@link Playlist}
     *     
     */
    public void setPlaylist(Playlist value) {
        this.playlist = value;
    }

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

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

    /**
     * Creates a new instance of {@link Playlist} and set it to playlist.
     * 
     * This method is a short version for:
     * {@code
     * Playlist playlist = new Playlist();
     * this.setPlaylist(playlist); }
     * 
     * 
     */
    public Playlist createAndSetPlaylist() {
        Playlist newValue = new Playlist();
        this.setPlaylist(newValue);
        return newValue;
    }

    /**
     * fluent setter
     *
     * 
     * @param playlist
     *     required parameter
     */
    public Tour withPlaylist(final Playlist playlist) {
        this.setPlaylist(playlist);
        return this;
    }

    @Obvious
    @Override
    public Tour withObjectSimpleExtension(final List