org.dmfs.httpessentials.entities.XWwwFormUrlEncodedEntity Maven / Gradle / Ivy

Go to download

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

Basic implementations of http-client-essentials that are frequently used.

There is a newer version: 1.22.1

/*
 * 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.entities;

import org.dmfs.httpessentials.client.HttpRequestEntity;
import org.dmfs.httpessentials.types.StructuredMediaType;
import org.dmfs.jems.iterable.decorators.Mapped;
import org.dmfs.jems.pair.Pair;
import org.dmfs.rfc3986.encoding.XWwwFormUrlEncoded;
import org.dmfs.rfc3986.parameters.Parameter;
import org.dmfs.rfc3986.parameters.ParameterList;
import org.dmfs.rfc3986.parameters.parametersets.BasicParameterList;


/**
 * An {@link HttpRequestEntity} that encodes key-value pairs using application/x-www-form-urlencoded encoding.
 *
 * @author Marten Gajda
 */
public final class XWwwFormUrlEncodedEntity extends DelegatingRequestEntity
{

    public XWwwFormUrlEncodedEntity(Iterable> values)
    {
        this(new BasicParameterList(new Mapped<>(PairParameter::new, values)));
    }


    // TODO: deprecate ParameterList and just use Iterable>
    public XWwwFormUrlEncodedEntity(final ParameterList values)
    {
        super(new TextRequestEntity(
                new StructuredMediaType("application", "x-www-form-urlencoded"),
                () -> new XWwwFormUrlEncoded(values)));
    }


    private static class PairParameter implements Parameter
    {
        private final Pair mKeyValuePair;


        public PairParameter(Pair keyValuePair)
        {
            mKeyValuePair = keyValuePair;
        }


        @Override
        public CharSequence name()
        {
            return mKeyValuePair.left();
        }


        @Override
        public CharSequence textValue()
        {
            return mKeyValuePair.right();
        }
    }
}