001package ezvcard.property;
002
003import java.time.Instant;
004import java.time.temporal.Temporal;
005
006/*
007 Copyright (c) 2012-2023, Michael Angstadt
008 All rights reserved.
009
010 Redistribution and use in source and binary forms, with or without
011 modification, are permitted provided that the following conditions are met: 
012
013 1. Redistributions of source code must retain the above copyright notice, this
014 list of conditions and the following disclaimer. 
015 2. Redistributions in binary form must reproduce the above copyright notice,
016 this list of conditions and the following disclaimer in the documentation
017 and/or other materials provided with the distribution. 
018
019 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
026 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029
030 The views and conclusions contained in the software and documentation are those
031 of the authors and should not be interpreted as representing official policies, 
032 either expressed or implied, of the FreeBSD Project.
033 */
034
035/**
036 * <p>
037 * Defines the date that the vCard was last modified by its owner.
038 * </p>
039 * 
040 * <p>
041 * <b>Code sample</b>
042 * </p>
043 * 
044 * <pre class="brush:java">
045 * VCard vcard = new VCard();
046 * 
047 * Revision rev = new Revision(Instant.now());
048 * vcard.setRevision(rev);
049 * </pre>
050 * 
051 * <p>
052 * <b>Property name:</b> {@code REV}
053 * </p>
054 * <p>
055 * <b>Supported versions:</b> {@code 2.1, 3.0, 4.0}
056 * </p>
057 * @author Michael Angstadt
058 * @see <a href="http://tools.ietf.org/html/rfc6350#page-45">RFC 6350 p.45</a>
059 * @see <a href="http://tools.ietf.org/html/rfc2426#page-22">RFC 2426 p.22</a>
060 * @see <a href="http://www.imc.org/pdi/vcard-21.doc">vCard 2.1 p.19</a>
061 */
062public class Revision extends SimpleProperty<Temporal> {
063        /**
064         * Creates a revision property.
065         * @param timestamp the timestamp when the vCard was last modified ({@link Instant}
066         * recommended)
067         */
068        public Revision(Temporal timestamp) {
069                super(timestamp);
070        }
071
072        /**
073         * Copy constructor.
074         * @param original the property to make a copy of
075         */
076        public Revision(Revision original) {
077                super(original);
078        }
079
080        /**
081         * Creates a revision property whose value is the current time.
082         * @return the property
083         */
084        public static Revision now() {
085                return new Revision(Instant.now());
086        }
087
088        @Override
089        public Revision copy() {
090                return new Revision(this);
091        }
092}