org.dmfs.httpessentials.parameters.Parametrized Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of http-client-essentials Show documentation

A lightweight http client model.

There is a newer version: 1.22.1

Show newest version

/*
 * Copyright (C) 2016 Marten Gajda 
 *
 *
 * 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.parameters;

import java.util.Iterator;


/**
 * Interface of an object that has typed parameters.
 *
 * @author Marten Gajda 
 */
public interface Parametrized
{
    /**
     * Returns the first {@link Parameter} of the given type or a parameter with a default value if no such parameter
     * exists.
     *
     * @param parameterType
     *         The {@link ParameterType}.
     * @param defaultValue
     *         The value to return in case no such parameter is present.
     *
     * @return The {@link Parameter}.
     */
    public  Parameter firstParameter(ParameterType parameterType, T defaultValue);

    /**
     * Returns an {@link Iterator} of all {@link Parameter}s of the given {@link ParameterType}. Returns an empty {@link
     * Iterator} of no such parameter exists.
     *
     * @param parameterType
     *         The {@link ParameterType} of the parameters to return.
     *
     * @return An {@link Iterator} of {@link Parameter}s.
     */
    public  Iterator> parameters(ParameterType parameterType);

    /**
     * Checks whether this object has a {@link Parameter} of the given {@link ParameterType}.
     *
     * @param parameterType
     *         The {@link ParameterType} to check.
     *
     * @return true if such a parameter is present, false otherwise.
     */
    public  boolean hasParameter(ParameterType parameterType);
}