src/com/google/doclava/AttributeInfo.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.Comparator;

public class AttributeInfo {
  public static final Comparator<AttributeInfo> comparator = new Comparator<AttributeInfo>() {
    public int compare(AttributeInfo a, AttributeInfo b) {
      return a.name().compareTo(b.name());
    }
  };

  public FieldInfo attrField;
  public ArrayList<MethodInfo> methods = new ArrayList<MethodInfo>();

  private ClassInfo mClass;
  private String mName;
  private Comment mComment;

  public AttributeInfo(ClassInfo cl, FieldInfo f) {
    mClass = cl;
    attrField = f;
  }

  public String name() {
    if (mName == null) {
      for (AttrTagInfo comment : attrField.comment().attrTags()) {
        String n = comment.name();
        if (n != null) {
          mName = n;
          return n;
        }
      }
      mName = attrField.name();
      Errors.error(Errors.BAD_ATTR_TAG, attrField.position(), mName + " referenced as an attribute,"
          + " but \"@attr name\" not specified.");
    }
    return mName;
  }

  public Comment comment() {
    if (mComment == null) {
      for (AttrTagInfo attr : attrField.comment().attrTags()) {
        Comment c = attr.description();
        if (c != null) {
          mComment = c;
          return c;
        }
      }
    }
    if (mComment == null) {
      return new Comment("", mClass, SourcePositionInfo.UNKNOWN);
    }
    return mComment;
  }

  public String anchor() {
    return "attr_" + name();
  }

  public String htmlPage() {
    return mClass.htmlPage() + "#" + anchor();
  }

  public void makeHDF(Data data, String base) {
    data.setValue(base + ".name", name());
    data.setValue(base + ".anchor", anchor());
    data.setValue(base + ".href", htmlPage());
    data.setValue(base + ".R.name", attrField.name());
    data.setValue(base + ".R.href", attrField.htmlPage());
    TagInfo.makeHDF(data, base + ".deprecated", attrField.comment().deprecatedTags());
    TagInfo.makeHDF(data, base + ".shortDescr", comment().briefTags());
    TagInfo.makeHDF(data, base + ".descr", comment().tags());

    int i = 0;
    for (MethodInfo m : methods) {
      String s = base + ".methods." + i;
      data.setValue(s + ".href", m.htmlPage());
      data.setValue(s + ".name", m.prettySignature());
    }
  }

  public boolean checkLevel() {
    return attrField.checkLevel();
  }
}