com.palantir.conjure.java.undertow.lib.PlainSerDe Maven / Gradle / Ivy

Go to download
/*
 * (c) Copyright 2019 Palantir Technologies Inc. All rights reserved.
 *
 * 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 com.palantir.conjure.java.undertow.lib;

import com.palantir.conjure.java.lib.SafeLong;
import com.palantir.ri.ResourceIdentifier;
import com.palantir.tokens.auth.BearerToken;
import java.time.OffsetDateTime;
import java.util.List;
import java.util.Optional;
import java.util.OptionalDouble;
import java.util.OptionalInt;
import java.util.Set;
import java.util.UUID;
import java.util.function.Function;
import javax.annotation.Nullable;

/**
 * Provides functionality to parse supported types using the
 * Conjure PLAIN format.
 *
 * These utilities are used to parse HTTP path, query, and header parameter values.
 */
public interface PlainSerDe {

    // TODO(ckozak): Write javadoc

    BearerToken deserializeBearerToken(@Nullable String in);

    BearerToken deserializeBearerToken(@Nullable Iterable in);

    Optional deserializeOptionalBearerToken(@Nullable String in);

    Optional deserializeOptionalBearerToken(@Nullable Iterable in);

    List deserializeBearerTokenList(@Nullable Iterable in);

    Set deserializeBearerTokenSet(@Nullable Iterable in);

    boolean deserializeBoolean(@Nullable String in);

    boolean deserializeBoolean(@Nullable Iterable in);

    Optional deserializeOptionalBoolean(@Nullable String in);

    Optional deserializeOptionalBoolean(@Nullable Iterable in);

    List deserializeBooleanList(@Nullable Iterable in);

    Set deserializeBooleanSet(@Nullable Iterable in);

    OffsetDateTime deserializeDateTime(@Nullable String in);

    OffsetDateTime deserializeDateTime(@Nullable Iterable in);

    Optional deserializeOptionalDateTime(@Nullable String in);

    Optional deserializeOptionalDateTime(@Nullable Iterable in);

    List deserializeDateTimeList(@Nullable Iterable in);

    Set deserializeDateTimeSet(@Nullable Iterable in);

    double deserializeDouble(@Nullable String in);

    double deserializeDouble(@Nullable Iterable in);

    OptionalDouble deserializeOptionalDouble(@Nullable String in);

    OptionalDouble deserializeOptionalDouble(@Nullable Iterable in);

    List deserializeDoubleList(@Nullable Iterable in);

    Set deserializeDoubleSet(@Nullable Iterable in);

    int deserializeInteger(@Nullable String in);

    int deserializeInteger(@Nullable Iterable in);

    OptionalInt deserializeOptionalInteger(@Nullable String in);

    OptionalInt deserializeOptionalInteger(@Nullable Iterable in);

    List deserializeIntegerList(@Nullable Iterable in);

    Set deserializeIntegerSet(@Nullable Iterable in);

    ResourceIdentifier deserializeRid(String in);

    ResourceIdentifier deserializeRid(@Nullable Iterable in);

    Optional deserializeOptionalRid(@Nullable String in);

    Optional deserializeOptionalRid(@Nullable Iterable in);

    List deserializeRidList(@Nullable Iterable in);

    Set deserializeRidSet(@Nullable Iterable in);

    SafeLong deserializeSafeLong(@Nullable String in);

    SafeLong deserializeSafeLong(@Nullable Iterable in);

    Optional deserializeOptionalSafeLong(@Nullable String in);

    Optional deserializeOptionalSafeLong(@Nullable Iterable in);

    List deserializeSafeLongList(@Nullable Iterable in);

    Set deserializeSafeLongSet(@Nullable Iterable in);

    String deserializeString(@Nullable String in);

    String deserializeString(@Nullable Iterable in);

    Optional deserializeOptionalString(@Nullable String in);

    Optional deserializeOptionalString(@Nullable Iterable in);

    List deserializeStringList(@Nullable Iterable in);

    Set deserializeStringSet(@Nullable Iterable in);

    UUID deserializeUuid(@Nullable String in);

    UUID deserializeUuid(@Nullable Iterable in);

    Optional deserializeOptionalUuid(@Nullable String in);

    Optional deserializeOptionalUuid(@Nullable Iterable in);

    List deserializeUuidList(@Nullable Iterable in);

    Set deserializeUuidSet(@Nullable Iterable in);

     T deserializeComplex(@Nullable String in, Function factory);

     T deserializeComplex(@Nullable Iterable in, Function factory);

     Optional deserializeOptionalComplex(@Nullable Iterable in, Function factory);

     List deserializeComplexList(@Nullable Iterable in, Function factory);

     Set deserializeComplexSet(@Nullable Iterable in, Function factory);
}