001 package ezvcard.parameter;
002
003 import java.util.Collection;
004
005 import ezvcard.VCardVersion;
006
007 /**
008 * Copyright 2011 George El-Haddad. All rights reserved.
009 *
010 * Redistribution and use in source and binary forms, with or without modification, are
011 * permitted provided that the following conditions are met:
012 *
013 * 1. Redistributions of source code must retain the above copyright notice, this list of
014 * conditions and the following disclaimer.
015 *
016 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
017 * of conditions and the following disclaimer in the documentation and/or other materials
018 * provided with the distribution.
019 *
020 * THIS SOFTWARE IS PROVIDED BY GEORGE EL-HADDAD ''AS IS'' AND ANY EXPRESS OR IMPLIED
021 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
022 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GEORGE EL-HADDAD OR
023 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
024 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
025 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
027 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
028 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 *
030 * The views and conclusions contained in the software and documentation are those of the
031 * authors and should not be interpreted as representing official policies, either expressed
032 * or implied, of George El-Haddad.
033 */
034
035 /*
036 Copyright (c) 2013, Michael Angstadt
037 All rights reserved.
038
039 Redistribution and use in source and binary forms, with or without
040 modification, are permitted provided that the following conditions are met:
041
042 1. Redistributions of source code must retain the above copyright notice, this
043 list of conditions and the following disclaimer.
044 2. Redistributions in binary form must reproduce the above copyright notice,
045 this list of conditions and the following disclaimer in the documentation
046 and/or other materials provided with the distribution.
047
048 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
049 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
050 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
051 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
052 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
053 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
054 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
055 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
056 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
057 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
058
059 The views and conclusions contained in the software and documentation are those
060 of the authors and should not be interpreted as representing official policies,
061 either expressed or implied, of the FreeBSD Project.
062 */
063
064 /**
065 * Represents the "ENCODING" parameter.
066 * <p>
067 * <b>Supported versions:</b> {@code 2.1, 3.0}
068 * </p>
069 * @author George El-Haddad Mar 10, 2010
070 * @author Michael Angstadt
071 */
072 public class Encoding extends VersionedVCardParameter {
073 private static final VCardParameterCaseClasses<Encoding> enums = new VCardParameterCaseClasses<Encoding>(Encoding.class);
074
075 /**
076 * <b>Supported versions:</b> {@code 2.1}
077 */
078 public static final Encoding QUOTED_PRINTABLE = new Encoding("quoted-printable", VCardVersion.V2_1);
079
080 /**
081 * <b>Supported versions:</b> {@code 2.1}
082 */
083 public static final Encoding BASE64 = new Encoding("base64", VCardVersion.V2_1);
084
085 /**
086 * <b>Supported versions:</b> {@code 2.1}
087 */
088 public static final Encoding _8BIT = new Encoding("8bit", VCardVersion.V2_1);
089
090 /**
091 * <b>Supported versions:</b> {@code 2.1}
092 */
093 public static final Encoding _7BIT = new Encoding("7bit", VCardVersion.V2_1);
094
095 /**
096 * <b>Supported versions:</b> {@code 3.0}
097 */
098 public static final Encoding B = new Encoding("b", VCardVersion.V3_0);
099
100 private Encoding(String value, VCardVersion... supportedVersions) {
101 super(value, supportedVersions);
102 }
103
104 /**
105 * Searches for a parameter value that is defined as a static constant in
106 * this class.
107 * @param value the parameter value
108 * @return the object or null if not found
109 */
110 public static Encoding find(String value) {
111 return enums.find(value);
112 }
113
114 /**
115 * Searches for a parameter value and creates one if it cannot be found. All
116 * objects are guaranteed to be unique, so they can be compared with
117 * {@code ==} equality.
118 * @param value the parameter value
119 * @return the object
120 */
121 public static Encoding get(String value) {
122 return enums.get(value);
123 }
124
125 /**
126 * Gets all of the parameter values that are defined as static constants in
127 * this class.
128 * @return the parameter values
129 */
130 public static Collection<Encoding> all() {
131 return enums.all();
132 }
133 }