com.google.api.generator.gapic.model.Sample Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gapic-generator-java Show documentation
GAPIC generator Java
There is a newer version: 2.51.1
// Copyright 2022 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
//
//      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.google.api.generator.gapic.model;

import com.google.api.generator.engine.ast.AssignmentExpr;
import com.google.api.generator.engine.ast.CommentStatement;
import com.google.api.generator.engine.ast.Statement;
import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableList;
import java.util.List;

/**
 * This model represents a generated code sample. It contains the information needed to generate a
 * sample file.
 */
@AutoValue
public abstract class Sample {
  public abstract List body();

  public abstract List variableAssignments();

  public abstract List fileHeader();

  public abstract RegionTag regionTag();

  public abstract String name();

  public abstract boolean isCanonical();

  public static Builder builder() {
    return new AutoValue_Sample.Builder()
        .setBody(ImmutableList.of())
        .setVariableAssignments(ImmutableList.of())
        .setFileHeader(ImmutableList.of())
        .setIsCanonical(false);
  }

  public abstract Builder toBuilder();

  /**
   * Helper method to easily update Sample's license header.
   *
   * @param header List of {@link CommentStatement} to replace Sample's header
   * @return Sample with updated header
   */
  public final Sample withHeader(List header) {
    return toBuilder().setFileHeader(header).build();
  }

  /**
   * Helper method to easily update Sample's region tag.
   *
   * @param regionTag {@link RegionTag} to replace Sample's header
   * @return Sample with updated region tag.
   */
  public final Sample withRegionTag(RegionTag regionTag) {
    if (isCanonical() && !regionTag.overloadDisambiguation().isEmpty()) {
      //  don't set overload on canonical samples
      withRegionTag(regionTag.withOverloadDisambiguation(""));
    }
    return toBuilder()
        .setName(generateSampleClassName(regionTag()))
        .setRegionTag(regionTag)
        .build();
  }

  @AutoValue.Builder
  public abstract static class Builder {
    public abstract Builder setBody(List body);

    public abstract Builder setVariableAssignments(List variableAssignments);

    public abstract Builder setFileHeader(List header);

    public abstract Builder setRegionTag(RegionTag regionTag);

    public abstract Builder setIsCanonical(boolean isCanonical);

    abstract Builder setName(String name);

    abstract Sample autoBuild();

    abstract RegionTag regionTag();

    abstract boolean isCanonical();

    public final Sample build() {
      if (isCanonical() && !regionTag().overloadDisambiguation().isEmpty()) {
        //  don't set overload on canonical samples
        setRegionTag(regionTag().withOverloadDisambiguation(""));
      }
      setName(generateSampleClassName(regionTag()));
      return autoBuild();
    }
  }

  private static String generateSampleClassName(RegionTag regionTag) {
    return (regionTag.isAsynchronous() ? "Async" : "Sync")
        + regionTag.rpcName()
        + regionTag.overloadDisambiguation();
  }
}