在继承类时重载Javadoc

时间:2012-09-21 12:22:29

标签: java javadoc

我有以下功能层次结构,我在Java中重新创建:

   Diagram
     |
     |--Model
          |
          |--Entity

所有这些对象共享一些公共属性(id,name)以及对层次结构中父对象的引用。所以我实现了一个抽象类:

abstract class DBObject{
   private final int id;
   private final String name;
   private final DBObject parent;

   //constructors, getters, setters here

   /**
    * @return reference to parent object in hierarchy.
    */
    public final getParent(){
       return parent;
    }
}

到目前为止没问题。问题是,该图没有父级,并且将始终返回null。这通过实施来确保。但我想在Diagram Javadoc中反映“parent always null”。 是否可以重载Javadoc,而无需重写方法?解决方案是在抽象类中说明一个注释,但这不是我正在寻找的答案。

感谢。

2 个答案:

答案 0 :(得分:1)

这个怎么样?

/**
* @return reference to parent object in hierarchy. may be null.
*/
@Nullable
public final DBObject getParent(){
   return parent;
}

答案 1 :(得分:1)

要替换Javadoc,您必须覆盖子类中的方法。

E.g。

Iterator.iterator()被覆盖了    由。覆盖的Collection.iterator()    由。覆盖的Set.iterator()    NavigableSet.iterator()只是为每个人提供不同的Javadoc。