All Downloads are FREE. Search and download functionalities are using the official Maven repository.

de.micromata.opengis.kml.v_2_2_0.TimeStamp Maven / Gradle / Ivy

Go to download

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;

import de.micromata.opengis.kml.v_2_2_0.annotations.Obvious;
import jakarta.xml.bind.annotation.*;

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


/**
 * {@code }
 * 

 * Represents a single moment in time. This is a simple element and contains no children. 
 * Its value is a dateTime, specified in XML time (see XML Schema Part 2: Datatypes 
 * Second Edition). The precision of the TimeStamp is dictated by the dateTime value 
 * in the {@code } element.
 * 

 * 
 * Syntax: 
 * 
<TimeStamp id=ID>
 *   <when>...</when>      <!-- kml:dateTime -->
 * </TimeStamp> 

 * 
 * Extends: 
 *
 * 
 * Contained By: 
 *
 *
 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "TimeStampType", propOrder = {
    "when",
    "timeStampSimpleExtension",
    "timeStampObjectExtension"
})
@XmlRootElement(name = "TimeStamp", namespace = "http://www.opengis.net/kml/2.2")
public class TimeStamp
    extends TimePrimitive
    implements Cloneable
{

    /**
     * {@code }
     * 

     * Specifies a single moment in time. The value is a dateTime, which can be one of 
     * the following: dateTime gives second resolution date gives day resolution gYearMonth 
     * gives month resolution gYear gives year resolution 
     * 

     * 
     * 
     * 
     */
    protected String when;
    @XmlElement(name = "TimeStampSimpleExtensionGroup")
    @XmlSchemaType(name = "anySimpleType")
    protected List timeStampSimpleExtension;
    /**
     * {@code }
     * 

     * This is an abstract base class and cannot be used directly in a KML file. It provides 
     * the id attribute, which allows unique identification of a KML element, and the targetId 
     * attribute, which is used to reference objects that have already been loaded into 
     * Google Earth. The id attribute must be assigned if the Update mechanism is to 
     * be used. 
     * 

     * 
     * Syntax: 
     * 
<!-- abstract element; do not create -->
     * <!-- Object id="ID" targetId="NCName" -->
     * <!-- /Object> -->

     * 
     * 
     * 
     */
    @XmlElement(name = "TimeStampObjectExtensionGroup")
    protected List timeStampObjectExtension;

    public TimeStamp() {
        super();
    }

    /**
     *
     * 
     * @return
     *     possible object is
     *     {@link String}
     *     
     */
    public String getWhen() {
        return when;
    }

    /**
     *
     * 
     * @param value
     *     allowed object is
     *     {@link String}
     *     
     */
    public void setWhen(String value) {
        this.when = value;
    }

    /**
     *
     * 
     */
    public List getTimeStampSimpleExtension() {
        if (timeStampSimpleExtension == null) {
            timeStampSimpleExtension = new ArrayList();
        }
        return this.timeStampSimpleExtension;
    }

    /**
     *
     * 
     */
    public List getTimeStampObjectExtension() {
        if (timeStampObjectExtension == null) {
            timeStampObjectExtension = new ArrayList();
        }
        return this.timeStampObjectExtension;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = super.hashCode();
        result = ((prime*result)+((when == null)? 0 :when.hashCode()));
        result = ((prime*result)+((timeStampSimpleExtension == null)? 0 :timeStampSimpleExtension.hashCode()));
        result = ((prime*result)+((timeStampObjectExtension == null)? 0 :timeStampObjectExtension.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 TimeStamp) == false) {
            return false;
        }
        TimeStamp other = ((TimeStamp) obj);
        if (when == null) {
            if (other.when!= null) {
                return false;
            }
        } else {
            if (when.equals(other.when) == false) {
                return false;
            }
        }
        if (timeStampSimpleExtension == null) {
            if (other.timeStampSimpleExtension!= null) {
                return false;
            }
        } else {
            if (timeStampSimpleExtension.equals(other.timeStampSimpleExtension) == false) {
                return false;
            }
        }
        if (timeStampObjectExtension == null) {
            if (other.timeStampObjectExtension!= null) {
                return false;
            }
        } else {
            if (timeStampObjectExtension.equals(other.timeStampObjectExtension) == false) {
                return false;
            }
        }
        return true;
    }

    /**
     *
     * 
     * @param timeStampSimpleExtension
     *     Objects of the following type are allowed in the list: {@link Object}
     */
    public void setTimeStampSimpleExtension(final List timeStampSimpleExtension) {
        this.timeStampSimpleExtension = timeStampSimpleExtension;
    }

    /**
     * add a value to the timeStampSimpleExtension property collection
     * 
     * @param timeStampSimpleExtension
     *     Objects of the following type are allowed in the list: {@link Object}
     * @return
     *     true (as general contract of Collection.add). 
     */
    public TimeStamp addToTimeStampSimpleExtension(final Object timeStampSimpleExtension) {
        this.getTimeStampSimpleExtension().add(timeStampSimpleExtension);
        return this;
    }

    /**
     *
     * 
     * @param timeStampObjectExtension
     *     Objects of the following type are allowed in the list: {@link Object}
     */
    public void setTimeStampObjectExtension(final List timeStampObjectExtension) {
        this.timeStampObjectExtension = timeStampObjectExtension;
    }

    /**
     * add a value to the timeStampObjectExtension property collection
     * 
     * @param timeStampObjectExtension
     *     Objects of the following type are allowed in the list: {@link AbstractObject}
     * @return
     *     true (as general contract of Collection.add). 
     */
    public TimeStamp addToTimeStampObjectExtension(final AbstractObject timeStampObjectExtension) {
        this.getTimeStampObjectExtension().add(timeStampObjectExtension);
        return this;
    }

    /**
     *
     * 
     */
    @Obvious
    @Override
    public void setObjectSimpleExtension(final List objectSimpleExtension) {
        super.setObjectSimpleExtension(objectSimpleExtension);
    }

    @Obvious
    @Override
    public TimeStamp addToObjectSimpleExtension(final Object objectSimpleExtension) {
        super.getObjectSimpleExtension().add(objectSimpleExtension);
        return this;
    }

    /**
     *
     * 
     */
    @Obvious
    @Override
    public void setTimePrimitiveSimpleExtension(final List timePrimitiveSimpleExtension) {
        super.setTimePrimitiveSimpleExtension(timePrimitiveSimpleExtension);
    }

    @Obvious
    @Override
    public TimeStamp addToTimePrimitiveSimpleExtension(final Object timePrimitiveSimpleExtension) {
        super.getTimePrimitiveSimpleExtension().add(timePrimitiveSimpleExtension);
        return this;
    }

    /**
     *
     * 
     */
    @Obvious
    @Override
    public void setTimePrimitiveObjectExtension(final List timePrimitiveObjectExtension) {
        super.setTimePrimitiveObjectExtension(timePrimitiveObjectExtension);
    }

    @Obvious
    @Override
    public TimeStamp addToTimePrimitiveObjectExtension(final AbstractObject timePrimitiveObjectExtension) {
        super.getTimePrimitiveObjectExtension().add(timePrimitiveObjectExtension);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param when
     *     required parameter
     */
    public TimeStamp withWhen(final String when) {
        this.setWhen(when);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param timeStampSimpleExtension
     *     required parameter
     */
    public TimeStamp withTimeStampSimpleExtension(final List timeStampSimpleExtension) {
        this.setTimeStampSimpleExtension(timeStampSimpleExtension);
        return this;
    }

    /**
     * fluent setter
     *
     * 
     * @param timeStampObjectExtension
     *     required parameter
     */
    public TimeStamp withTimeStampObjectExtension(final List timeStampObjectExtension) {
        this.setTimeStampObjectExtension(timeStampObjectExtension);
        return this;
    }

    @Obvious
    @Override
    public TimeStamp withObjectSimpleExtension(final List objectSimpleExtension) {
        super.withObjectSimpleExtension(objectSimpleExtension);
        return this;
    }

    @Obvious
    @Override
    public TimeStamp withId(final String id) {
        super.withId(id);
        return this;
    }

    @Obvious
    @Override
    public TimeStamp withTargetId(final String targetId) {
        super.withTargetId(targetId);
        return this;
    }

    @Obvious
    @Override
    public TimeStamp withTimePrimitiveSimpleExtension(final List timePrimitiveSimpleExtension) {
        super.withTimePrimitiveSimpleExtension(timePrimitiveSimpleExtension);
        return this;
    }

    @Obvious
    @Override
    public TimeStamp withTimePrimitiveObjectExtension(final List timePrimitiveObjectExtension) {
        super.withTimePrimitiveObjectExtension(timePrimitiveObjectExtension);
        return this;
    }

    @Override
    public TimeStamp clone() {
        TimeStamp copy;
        copy = ((TimeStamp) super.clone());
        copy.timeStampSimpleExtension = new ArrayList((getTimeStampSimpleExtension().size()));
        for (Object iter: timeStampSimpleExtension) {
            copy.timeStampSimpleExtension.add(iter);
        }
        copy.timeStampObjectExtension = new ArrayList((getTimeStampObjectExtension().size()));
        for (AbstractObject iter: timeStampObjectExtension) {
            copy.timeStampObjectExtension.add(iter.clone());
        }
        return copy;
    }

}
 















© 2015 - 2024 Weber Informatics LLC | Privacy Policy