org.mattressframework.api.http.HttpMethod Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mattress-api Show documentation

Public API to the Mattress framework. This is essentially what JSR 311 should be.

There is a newer version: 1.0.0-ALPHA4

/*
 * Copyright 2007-2008, Josh Devins.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.mattressframework.api.http;

/**
 * Enumeration of all the HTTP method definitions.
 * 
 * 
 * RFC 2616 (HTTP/1.1), Section 9 Method
 * Definitions
 * 
 * 
 * @author Josh Devins ([email protected])
 */
public enum HttpMethod {
    OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT;

    /**
     * Determines if the HTTP method should have an entity body in the request
     * with it.
     * 
     * @return Returns true if this {@link HttpMethod} is
     *         {@link HttpMethod#POST} or {@link HttpMethod#PUT}, and
     *         false otherwise.
     */
    public boolean hasEntity() {
        return this.equals(POST) || this.equals(PUT);
    }
}