com.google.api.tools.framework.model.ProtoContainerElement Maven / Gradle / Ivy

/*
 * Copyright (C) 2016 Google Inc.
 *
 * 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.tools.framework.model;

import com.google.common.collect.ImmutableList;
import com.google.protobuf.DescriptorProtos.DescriptorProto;
import com.google.protobuf.DescriptorProtos.EnumDescriptorProto;

import java.util.List;

import javax.annotation.Nullable;

/**
 * Base class of protocol elements which are containers for messages and enums (proto files and
 * messages).
 */
public abstract class ProtoContainerElement extends ProtoElement {

  private ImmutableList messages;
  private ImmutableList enums;

  /**
   * Creates the container element, given its parent and (simple) name, and a list of messages and
   * enum types. Any child class must call {@link #buildChildren} in the constructor to initialize
   * child elements. The initialization is done in the child so methods like {@link #getFullName}
   * work during initialization.
   */
  protected ProtoContainerElement(@Nullable ProtoElement parent, String name, String path) {
    super(parent, name, path);
  }

  /**
   * Returns the messages.
   */
  public ImmutableList getMessages() {
    return messages;
  }

  /**
   * Returns the enums.
   */
  public ImmutableList getEnums() {
    return enums;
  }

  protected void buildChildren(List messageList,
      List enumList,
      String path,
      int messageTypeNumber,
      int enumTypeNumber,
      ExtensionPool extensionPool) {
    // Build messages.
    ImmutableList.Builder messagesBuilder = ImmutableList.builder();
    for (int i = 0; i < messageList.size(); i++) {
      String childPath = buildPath(path, messageTypeNumber, i);
      messagesBuilder.add(MessageType.create(this, messageList.get(i), childPath, extensionPool));
    }
    messages = messagesBuilder.build();

    // Build enums.
    ImmutableList.Builder enumsBuilder = ImmutableList.builder();
    for (int i = 0; i < enumList.size(); i++) {
      String childPath = buildPath(path, enumTypeNumber, i);
      enumsBuilder.add(EnumType.create(this, enumList.get(i), childPath));
    }
    enums = enumsBuilder.build();
  }
}