xref: /external/doclava/src/com/google/doclava/DocInfo.java

/*
 * Copyright (C) 2010 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.doclava;

import com.google.clearsilver.jsilver.data.Data;

import java.util.ArrayList;
import java.util.LinkedHashSet;
import java.util.Set;

public abstract class DocInfo {
  public DocInfo(String rawCommentText, SourcePositionInfo sp) {
    mRawCommentText = rawCommentText;
    mPosition = sp;
  }

  /**
   * The relative path to a web page representing this item.
   */
  public abstract String htmlPage();

  /**
   * @return true if the element has never been a part of public API
   */
  public boolean isHidden() {
    return comment().isHidden();
  }

  /**
   * @return true if the element was once a part of public API, now removed.
   */
  public boolean isRemoved() {
    return comment().isRemoved();
  }

  /**
   * Hidden and removed elements should not be appear in api.txt files, nor
   * should they appear in the java doc.
   * @return true if the element is either hidden or removed.
   */
  public boolean isHiddenOrRemoved() {
   return isHidden() || isRemoved();
  }

  public boolean isDocOnly() {
    return comment().isDocOnly();
  }

  public String getRawCommentText() {
    return mRawCommentText;
  }

  public void setRawCommentText(String rawCommentText) {
      mRawCommentText = rawCommentText;

      // so that if we've created one prior to changing, we recreate it
      if (mComment != null) {
          mComment = new Comment(mRawCommentText, parent(), mPosition);
      }

  }

  public Comment comment() {
    if (mComment == null) {
      mComment = new Comment(mRawCommentText, parent(), mPosition);
    }
    return mComment;
  }

  public SourcePositionInfo position() {
    return mPosition;
  }

  public void setPosition(SourcePositionInfo position) {
      mPosition = position;

      // so that if we've created one prior to changing, we recreate it
      if (mComment != null) {
          mComment = new Comment(mRawCommentText, parent(), mPosition);
      }
  }

  public abstract ContainerInfo parent();

  public void setSince(String since) {
    mSince = since;
  }

  public String getSince() {
    if (Doclava.METALAVA_API_SINCE) {
      mSince = comment().getApiSince();
    }
    return mSince;
  }

  /**
   * Sets the artifact in which the class resides.
   * <p>
   * This property should be specified as a full Maven dependency spec. For example, a Support
   * Library core utility class may use "com.android.support:support-core-utils:26.0.1".
   *
   * @param artifact the artifact in which the class resides
   * @return
   */
  public void setArtifact(String artifact) {
    mArtifact = artifact;
  }

  /**
   * Returns the artifact in which the class resides.
   */
  public String getArtifact() {
    return mArtifact;
  }

  public void setDeprecatedSince(String since) {
    mDeprecatedSince = since;
  }

  public String getDeprecatedSince() {
    if (Doclava.METALAVA_API_SINCE) {
        return comment().getDeprecatedSince();
    } else {
        return mDeprecatedSince;
    }
  }

  public boolean isDeprecated() {
    if (Doclava.METALAVA_API_SINCE) {
      return comment().isDeprecated();
    } else {
      return mDeprecatedSince != null ? true : false;
    }
  }

  public final void addFederatedReference(FederatedSite source) {
    mFederatedReferences.add(source);
  }

  public final Set<FederatedSite> getFederatedReferences() {
    return mFederatedReferences;
  }

  public final void setFederatedReferences(Data data, String base) {
    int pos = 0;
    for (FederatedSite source : getFederatedReferences()) {
      data.setValue(base + ".federated." + pos + ".url", source.linkFor(htmlPage()));
      data.setValue(base + ".federated." + pos + ".name", source.name());
      pos++;
    }
  }

  private String mRawCommentText;
  Comment mComment;
  SourcePositionInfo mPosition;
  private String mSince;
  private String mArtifact;
  private String mDeprecatedSince;
  private Set<FederatedSite> mFederatedReferences = new LinkedHashSet<FederatedSite>();
}