com.google.api.codegen.common.GeneratedResult.java Source code

Introduction

Here is the source code for com.google.api.codegen.common.GeneratedResult.java

Source

/* Copyright 2016 Google LLC
 *
 * 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
 *
 *      https://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.google.api.codegen.common;

import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableMap;
import java.util.Map;
import java.util.Objects;

/** Represents a generated result and its properties. */
@AutoValue
public abstract class GeneratedResult<T> {

    /**
     * Creates a new instance.
     *
     * @param body body (content) of the generated result
     * @param executable {@code true} if the generated result should be specified as executable when
     *     persisted to a file, {@code false} otherwise
     * @param <T> class which represents result body, usually {@code Doc} or {@code byte[]}
     */
    public static <T> GeneratedResult<T> create(T body, boolean executable) {
        return new AutoValue_GeneratedResult<>(body, executable);
    }

    /**
     * Converts a map of results (body plus properties) to a map of bodies (stripping properties).
     *
     * @param results results map to convert
     * @param <T> class which represents result body
     */
    public static <T> Map<String, T> extractBodies(Map<String, GeneratedResult<T>> results) {
        ImmutableMap.Builder<String, T> extractedResults = ImmutableMap.builder();
        for (Map.Entry<String, GeneratedResult<T>> entry : results.entrySet()) {
            extractedResults.put(entry.getKey(), Objects.requireNonNull(entry.getValue().getBody()));
        }
        return extractedResults.build();
    }

    /** Returns the body (content) of the result. */
    public abstract T getBody();

    /** Returns {@code true} if the result represents an executable file, {@code false} otherwise. */
    public abstract boolean isExecutable();
}