001 package biweekly.property;
002
003 import java.util.List;
004
005 import biweekly.component.ICalComponent;
006
007 /*
008 Copyright (c) 2013, Michael Angstadt
009 All rights reserved.
010
011 Redistribution and use in source and binary forms, with or without
012 modification, are permitted provided that the following conditions are met:
013
014 1. Redistributions of source code must retain the above copyright notice, this
015 list of conditions and the following disclaimer.
016 2. Redistributions in binary form must reproduce the above copyright notice,
017 this list of conditions and the following disclaimer in the documentation
018 and/or other materials provided with the distribution.
019
020 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
021 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
022 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
023 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
024 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
025 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
026 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
027 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
028 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
029 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
030 */
031
032 /**
033 * <p>
034 * Specifies the min/max versions a consumer must support in order to
035 * successfully parse the iCalendar object.
036 * </p>
037 * <p>
038 * <b>Examples:</b>
039 *
040 * <pre class="brush:java">
041 * //the default iCal version
042 * Version version = Version.v2_0();
043 *
044 * if (verison.isV2_0()) {
045 * //version is "2.0"
046 * }
047 * </pre>
048 *
049 * </p>
050 * @author Michael Angstadt
051 * @rfc 5545 p.79-80
052 */
053 public class Version extends ICalProperty {
054 private static final String DEFAULT = "2.0";
055
056 private String minVersion, maxVersion;
057
058 /**
059 * Creates a new version property.
060 * @param version the version that a consumer must support in order to
061 * successfully parse the iCalendar object
062 */
063 public Version(String version) {
064 this(null, version);
065 }
066
067 /**
068 * Creates a new version property.
069 * @param minVersion the minimum version that a consumer must support in
070 * order to successfully parse the iCalendar object
071 * @param maxVersion the maximum version that a consumer must support in
072 * order to successfully parse the iCalendar object
073 */
074 public Version(String minVersion, String maxVersion) {
075 this.minVersion = minVersion;
076 this.maxVersion = maxVersion;
077 }
078
079 /**
080 * Creates a version property that is set to the default iCalendar version
081 * (2.0).
082 * @return the property instance
083 */
084 public static Version v2_0() {
085 return new Version(DEFAULT);
086 }
087
088 /**
089 * Determines if this version is the default iCalendar version.
090 * @return true if the version is "2.0", false if not
091 */
092 public boolean isV2_0() {
093 return DEFAULT.equalsIgnoreCase(maxVersion);
094 }
095
096 /**
097 * Gets the minimum version that a consumer must support in order to
098 * successfully parse the iCalendar object.
099 * @return the minimum version or null if not set
100 */
101 public String getMinVersion() {
102 return minVersion;
103 }
104
105 /**
106 * Sets the minimum version that a consumer must support in order to
107 * successfully parse the iCalendar object.
108 * @param minVersion the minimum version or null to remove
109 */
110 public void setMinVersion(String minVersion) {
111 this.minVersion = minVersion;
112 }
113
114 /**
115 * Gets the maximum version that a consumer must support in order to
116 * successfully parse the iCalendar object.
117 * @return the maximum version or null if not set
118 */
119 public String getMaxVersion() {
120 return maxVersion;
121 }
122
123 /**
124 * Sets the maximum version that a consumer must support in order to
125 * successfully parse the iCalendar object.
126 * @param maxVersion the maximum version (this field is <b>required</b>)
127 */
128 public void setMaxVersion(String maxVersion) {
129 this.maxVersion = maxVersion;
130 }
131
132 @Override
133 protected void validate(List<ICalComponent> components, List<String> warnings) {
134 if (maxVersion == null) {
135 warnings.add("A maximum version must be specified.");
136 }
137 }
138 }