KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > gargoylesoftware > htmlunit > FormEncodingType


1 /*
2  * Copyright (c) 2002, 2005 Gargoyle Software Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright notice,
10  * this list of conditions and the following disclaimer in the documentation
11  * and/or other materials provided with the distribution.
12  * 3. The end-user documentation included with the redistribution, if any, must
13  * include the following acknowledgment:
14  *
15  * "This product includes software developed by Gargoyle Software Inc.
16  * (http://www.GargoyleSoftware.com/)."
17  *
18  * Alternately, this acknowledgment may appear in the software itself, if
19  * and wherever such third-party acknowledgments normally appear.
20  * 4. The name "Gargoyle Software" must not be used to endorse or promote
21  * products derived from this software without prior written permission.
22  * For written permission, please contact info@GargoyleSoftware.com.
23  * 5. Products derived from this software may not be called "HtmlUnit", nor may
24  * "HtmlUnit" appear in their name, without prior written permission of
25  * Gargoyle Software Inc.
26  *
27  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
28  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
29  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE
30  * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
31  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
33  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
36  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37  */

38 package com.gargoylesoftware.htmlunit;
39
40 import org.org.apache.commons.httpclient.methods.PostMethod;
41
42 /**
43  * A collection of constants that represent the various ways a form can be
44  * encoded when submitted
45  *
46  * @version $Revision: 100 $
47  * @author Brad Clarke
48  */

49 public final class FormEncodingType {
50
51     /**
52      * URL_ENCODED
53      */

54     public static final FormEncodingType URL_ENCODED =
55         new FormEncodingType(PostMethod.FORM_URL_ENCODED_CONTENT_TYPE);
56     /**
57      * MULTIPART
58      * This used to be a constant in httpcommons but it was deprecated with no alternative.
59      */

60     public static final FormEncodingType MULTIPART = new FormEncodingType("multipart/form-data");
61
62     private final String JavaDoc name_;
63
64     private FormEncodingType(final String JavaDoc name) {
65         name_ = name;
66     }
67
68     /**
69      * Return the name of this EncodingType
70      *
71      * @return See above
72      */

73     public String JavaDoc getName() {
74         return name_;
75     }
76
77     /**
78      * Return the constant that matches the given name
79      *
80      * @param name The name to search by
81      * @return See above
82      */

83     public static FormEncodingType getInstance(final String JavaDoc name) {
84         final String JavaDoc lowerCaseName = name.toLowerCase();
85         final FormEncodingType allInstances[] = new FormEncodingType[] { URL_ENCODED, MULTIPART };
86
87         int i;
88         for (i = 0; i < allInstances.length; i++) {
89             if (allInstances[i].getName().equals(lowerCaseName)) {
90                 return allInstances[i];
91             }
92         }
93
94         // Special case: empty string defaults to url encoded
95
if (name.equals("")) {
96             return URL_ENCODED;
97         }
98
99         throw new IllegalArgumentException JavaDoc("No encoding type found for [" + name + "]");
100     }
101
102     /**
103      * Return a string representation of this object
104      *
105      * @return See above
106      */

107     public String JavaDoc toString() {
108         return "EncodingType[name=" + getName() + "]";
109     }
110 }
111
Popular Tags