001/*
002 * Copyright 2008-2011 Thomas Nichols.  http://blog.thomnichols.org
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * You are receiving this code free of charge, which represents many hours of
017 * effort from other individuals and corporations.  As a responsible member
018 * of the community, you are encouraged (but not required) to donate any
019 * enhancements or improvements back to the community under a similar open
020 * source license.  Thank you. -TMN
021 */
022package groovyx.net.http;
023
024import org.apache.http.HttpRequest;
025import org.apache.http.client.methods.HttpDelete;
026import org.apache.http.client.methods.HttpGet;
027import org.apache.http.client.methods.HttpHead;
028import org.apache.http.client.methods.HttpPost;
029import org.apache.http.client.methods.HttpPut;
030import org.apache.http.client.methods.HttpPatch;
031import org.apache.http.client.methods.HttpRequestBase;
032
033/**
034 * Enumeration of valid HTTP methods that may be used in a
035 * {@link HTTPBuilder#request(Method, groovy.lang.Closure) request} call.
036 * @author <a href='mailto:[email protected]'>Tom Nichols</a>
037 */
038public enum Method {
039    GET( HttpGet.class ),
040    PUT( HttpPut.class ),
041    POST( HttpPost.class ),
042    DELETE( HttpDelete.class ),
043    HEAD( HttpHead.class ),
044    PATCH( HttpPatch.class );
045
046    private final Class<? extends HttpRequestBase> requestType;
047
048    /**
049     * Get the HttpRequest class that represents this request type.
050     * @return a non-abstract class that implements {@link HttpRequest}
051     */
052    public Class<? extends HttpRequestBase> getRequestType() { return this.requestType; }
053
054    private Method( Class<? extends HttpRequestBase> type ) {
055        this.requestType = type;
056    }
057}