All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.dmfs.httpessentials.methods.AbstractMethod Maven / Gradle / Ivy

/*
 * Copyright 2017 dmfs GmbH
 *
 *
 * 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.dmfs.httpessentials.methods;

import org.dmfs.httpessentials.HttpMethod;


/**
 * An abstract {@link HttpMethod}. By default this method is not safe and not idempotent.
 *
 * @author Marten Gajda
 */
public abstract class AbstractMethod implements HttpMethod
{
    /**
     * The method verb.
     */
    private final String mVerb;

    private final Boolean mSupportsRequestPayload;


    /**
     * Instantiates a new {@link HttpMethod} with the given verb.
     *
     * @param verb
     *         The method verb.
     * @param supportsRequestPayload
     *         whether this method support sending a request message body.
     */
    public AbstractMethod(final String verb, final boolean supportsRequestPayload)
    {
        mVerb = verb;
        mSupportsRequestPayload = supportsRequestPayload;
    }


    @Override
    public final String verb()
    {
        return mVerb;
    }


    @Override
    public final boolean supportsRequestPayload()
    {
        return mSupportsRequestPayload;
    }


    @Override
    public final int hashCode()
    {
        return mVerb.hashCode();
    }


    @Override
    public final boolean equals(final Object obj)
    {
        if (!(obj instanceof HttpMethod))
        {
            return false;
        }
        HttpMethod other = (HttpMethod) obj;
        return obj == this || mVerb.equals(other.verb()); // two methods are considered to equal when their verbs equal
    }
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy