001 package ezvcard.parameter;
002
003 import java.util.Collection;
004
005 import ezvcard.property.Key;
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 TYPE parameter of the {@link Key} property.
066 * <p>
067 * <b>Supported versions:</b> {@code 2.1, 3.0, 4.0}
068 * </p>
069 * @author George El-Haddad Mar 10, 2010
070 * @author Michael Angstadt Jul 06, 2012
071 */
072 public class KeyType extends MediaTypeParameter {
073 private static final MediaTypeCaseClasses<KeyType> enums = new MediaTypeCaseClasses<KeyType>(KeyType.class);
074
075 public static final KeyType PGP = new KeyType("PGP", "application/pgp-keys", "pgp");
076 public static final KeyType GPG = new KeyType("GPG", "application/gpg", "gpg");
077 public static final KeyType X509 = new KeyType("X509", "application/x509", null);
078
079 private KeyType(String value, String mediaType, String extension) {
080 super(value, mediaType, extension);
081 }
082
083 /**
084 * Searches for a parameter value that is defined as a static constant in
085 * this class.
086 * @param type the TYPE parameter value to search for (e.g. "PGP") or null
087 * to not search by this value
088 * @param mediaType the media type to search for (e.g.
089 * "application/pgp-keys") or null to not search by this value
090 * @param extension the file extension to search for (excluding the ".",
091 * e.g. "pgp") or null to not search by this value
092 * @return the object or null if not found
093 */
094 public static KeyType find(String type, String mediaType, String extension) {
095 return enums.find(new String[] { type, mediaType, extension });
096 }
097
098 /**
099 * Searches for a parameter value and creates one if it cannot be found. All
100 * objects are guaranteed to be unique, so they can be compared with
101 * {@code ==} equality.
102 * @param type the TYPE parameter value to search for (e.g. "PGP") or null
103 * to not search by this value
104 * @param mediaType the media type to search for (e.g.
105 * "application/pgp-keys") or null to not search by this value
106 * @param extension the file extension to search for (excluding the ".",
107 * e.g. "pgp") or null to not search by this value
108 * @return the object
109 */
110 public static KeyType get(String type, String mediaType, String extension) {
111 return enums.get(new String[] { type, mediaType, extension });
112 }
113
114 /**
115 * Gets all of the parameter values that are defined as static constants in
116 * this class.
117 * @return the parameter values
118 */
119 public static Collection<KeyType> all() {
120 return enums.all();
121 }
122 }