com.spectralogic.ds3autogen.java.utils.CommonRequestGeneratorUtils.java Source code

Introduction

Here is the source code for com.spectralogic.ds3autogen.java.utils.CommonRequestGeneratorUtils.java

Source

/*
 * ******************************************************************************
 *   Copyright 2014-2015 Spectra Logic Corporation. 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. A copy of the License is located at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 *   or in the "license" file accompanying this file.
 *   This file 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.spectralogic.ds3autogen.java.utils;

import com.google.common.collect.ImmutableList;
import com.spectralogic.ds3autogen.api.models.Arguments;
import com.spectralogic.ds3autogen.api.models.docspec.Ds3DocSpec;
import com.spectralogic.ds3autogen.java.models.QueryParam;
import com.spectralogic.ds3autogen.java.models.RequestConstructor;
import com.spectralogic.ds3autogen.utils.collections.GuavaCollectors;

import static com.spectralogic.ds3autogen.java.utils.JavaDocGenerator.toConstructorDocs;
import static com.spectralogic.ds3autogen.utils.ConverterUtil.hasContent;
import static com.spectralogic.ds3autogen.utils.ConverterUtil.isEmpty;

/**
 * Contains static util methods used by some of the Java Request Generators, but not
 * by all. Methods in this class should have no clear placement within the request
 * generator inheritance structure.
 */
public class CommonRequestGeneratorUtils {

    /**
     * Creates a constructor with the provided parameters in addition to
     * adding the required parameter Stream for parsing a request payload.
     */
    public static RequestConstructor createInputStreamConstructor(final ImmutableList<Arguments> parameters,
            final ImmutableList<QueryParam> queryParams, final String requestName, final Ds3DocSpec docSpec) {
        final ImmutableList.Builder<Arguments> builder = ImmutableList.builder();
        if (hasContent(parameters)) {
            builder.addAll(parameters);
        }
        builder.add(new Arguments("InputStream", "Stream"));

        final ImmutableList<Arguments> updatedParameters = builder.build();
        final ImmutableList<String> argNames = updatedParameters.stream().map(Arguments::getName)
                .collect(GuavaCollectors.immutableList());

        return new RequestConstructor(updatedParameters, updatedParameters, queryParams,
                toConstructorDocs(requestName, argNames, docSpec, 1));
    }

    /**
     * Creates a constructor with the provided parameters in addition to
     * adding the required parameter Channel for parsing a request payload.
     */
    public static RequestConstructor createChannelConstructor(final ImmutableList<Arguments> parameters,
            final ImmutableList<QueryParam> queryParams, final String requestName, final Ds3DocSpec docSpec) {
        final ImmutableList.Builder<Arguments> builder = ImmutableList.builder();
        builder.addAll(parameters);
        builder.add(new Arguments("SeekableByteChannel", "Channel"));

        final ImmutableList<String> additionalLines = ImmutableList
                .of("this.stream = new SeekableByteChannelInputStream(channel);");

        final ImmutableList<Arguments> updatedParameters = builder.build();

        final ImmutableList<String> argNames = updatedParameters.stream().map(Arguments::getName)
                .collect(GuavaCollectors.immutableList());

        return new RequestConstructor(false, additionalLines, updatedParameters, updatedParameters, queryParams,
                toConstructorDocs(requestName, argNames, docSpec, 1));
    }

    /**
     * Converts a list of arguments into a list of query params
     */
    public static ImmutableList<QueryParam> argsToQueryParams(final ImmutableList<Arguments> args) {
        if (isEmpty(args)) {
            return ImmutableList.of();
        }
        return args.stream().map(QueryParam::new).collect(GuavaCollectors.immutableList());
    }
}