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