com.sun.source.doctree.SerialFieldTree Java Examples

protected final SerialFieldTree rewriteChildren(SerialFieldTree tree) {
    SerialFieldTree value = tree;
    IdentifierTree name = (IdentifierTree) translate(tree.getName());
    List<? extends DocTree> description = translateDoc(tree.getDescription());
    ReferenceTree ref = (ReferenceTree) translate(tree.getType());
    if (ref != tree.getType() || name != tree.getName() || description != tree.getDescription()) {
        value = make.SerialField(name, ref, description);
    }
    return value;
}
 

@Override
public Void visitSerialField(SerialFieldTree node, Void p) {
    printTagName(node);
    print(" ");
    print((DCTree)node.getName());
    print(" ");
    print((DCTree)node.getType());
    if (!node.getDescription().isEmpty()) {
        print(" ");
        for (DocTree docTree : node.getDescription()) {
            doAccept((DCTree)docTree);
        }
    }
    return null;
}
 

/**
 * Returns a Comparator for SerialFieldTree.
 * @return a Comparator
 */
public Comparator<SerialFieldTree> makeSerialFieldTreeComparator() {
    return (SerialFieldTree o1, SerialFieldTree o2) -> {
        String s1 = o1.getName().toString();
        String s2 = o2.getName().toString();
        return s1.compareTo(s2);
    };
}
 

public ReferenceTree getType(DocTree dtree) {
    if (dtree.getKind() == SERIAL_FIELD) {
        return ((SerialFieldTree)dtree).getType();
    } else {
        return null;
    }
}
 

public IdentifierTree getName(DocTree dtree) {
    switch (dtree.getKind()) {
        case PARAM:
            return ((ParamTree)dtree).getName();
        case SERIAL_FIELD:
            return ((SerialFieldTree)dtree).getName();
        default:
            return null;
        }
}
 

@Override
public Void visitSerialField(SerialFieldTree node, List<ErrorDescription> errors) {
    boolean oldInheritDoc = foundInheritDoc;
    super.visitSerialField(node, errors);
    foundInheritDoc = oldInheritDoc;
    return null;
}
 

public DocTree visitSerialField(SerialFieldTree node, Element p, Void ignore) {
    return super.visitSerialField(node, p);
}
 

@Override
public Void visitSerialField(SerialFieldTree tree, Void ignore) {
    warnIfEmpty(tree, tree.getDescription());
    return super.visitSerialField(tree, ignore);
}
 

@Override
public Void visitSerialField(SerialFieldTree tree, Void ignore) {
    warnIfEmpty(tree, tree.getDescription());
    return super.visitSerialField(tree, ignore);
}
 

@Override
public Void visitSerialField(SerialFieldTree tree, Void ignore) {
    warnIfEmpty(tree, tree.getDescription());
    return super.visitSerialField(tree, ignore);
}
 

/**
 * Build the serial field tags information.
 *
 * @param serializableFieldsTree content tree to which the documentation will be added
 */
public void buildSerialFieldTagsInfo(Content serializableFieldsTree) {
    if(configuration.nocomment){
        return;
    }
    VariableElement field = (VariableElement)currentMember;
    // Process Serializable Fields specified as array of
    // ObjectStreamFields. Print a member for each serialField tag.
    // (There should be one serialField tag per ObjectStreamField
    // element.)
    SortedSet<SerialFieldTree> tags = new TreeSet<>(utils.makeSerialFieldTreeComparator());
    // sort the elements
    for (DocTree dt : utils.getSerialFieldTrees(field)) {
        SerialFieldTree st = (SerialFieldTree) dt;
        tags.add(st);
    }

    CommentHelper ch = utils.getCommentHelper(field);
    for (SerialFieldTree tag : tags) {
        if (tag.getName() == null || tag.getType() == null)  // ignore malformed @serialField tags
            continue;
        Content fieldsContentTree = fieldWriter.getFieldsContentHeader(tag.equals(tags.last()));
        TypeElement te = ch.getReferencedClass(configuration, tag);
        String fieldType = ch.getReferencedMemberName(tag);
        if (te != null && utils.isPrimitive(te.asType())) {
            fieldType = utils.getTypeName(te.asType(), false);
            te = null;
        }
        String refSignature = ch.getReferencedSignature(tag);
        // TODO: Print the signature directly, if it is an array, the
        // current DocTree APIs makes it very hard to distinguish
        // an as these are returned back as "Array" a DeclaredType.
        if (refSignature.endsWith("[]")) {
            te = null;
            fieldType = refSignature;
        }
        fieldWriter.addMemberHeader(te, fieldType, "",
                tag.getName().getName().toString(), fieldsContentTree);
        fieldWriter.addMemberDescription(field, tag, fieldsContentTree);
        serializableFieldsTree.addContent(fieldsContentTree);
    }
}
 

@Override @DefinedBy(Api.COMPILER_TREE)
public Void visitSerialField(SerialFieldTree tree, Void ignore) {
    warnIfEmpty(tree, tree.getDescription());
    return super.visitSerialField(tree, ignore);
}
 

@Override
public Void visitSerialField(SerialFieldTree tree, Void ignore) {
    warnIfEmpty(tree, tree.getDescription());
    return super.visitSerialField(tree, ignore);
}
 

@Override
public Void visitSerialField(SerialFieldTree tree, Void ignore) {
    warnIfEmpty(tree, tree.getDescription());
    return super.visitSerialField(tree, ignore);
}
 

@Override
public DocTree visitSerialField(SerialFieldTree node, Element p) {
    return instance.visitSerialField(node, p);
}
 

/**
 * @since 1.47
 */
@Override
public DocTree visitSerialField(SerialFieldTree node, Element p) {
    return docScanner.visitSerialField(node, p, null);
}
 

public SerialFieldTree SerialField(com.sun.source.doctree.IdentifierTree name, ReferenceTree type, List<? extends DocTree> description) {
    return docMake.at(NOPOS).newSerialFieldTree(name, type, description);
}
 

@Override
public DocTree visitSerialField(SerialFieldTree tree, Object p) {
    return rewriteChildren(tree);
}
 

@Override
public Void visitSerialField(SerialFieldTree tree, Void ignore) {
    warnIfEmpty(tree, tree.getDescription());
    return super.visitSerialField(tree, ignore);
}
 

@Override
public Void visitSerialField(SerialFieldTree tree, Void ignore) {
    warnIfEmpty(tree, tree.getDescription());
    return super.visitSerialField(tree, ignore);
}
 

/**
 * Create a new {@code SerialFieldTree} object, to represent a {@code @serialField } tag.
 * @param name the name of the field
 * @param type the type of the field
 * @param description the description of the field
 * @return a {@code SerialFieldTree} object
 */
SerialFieldTree newSerialFieldTree(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description);
 

/**Creates the DocTree's SerialFieldTree.
 * 
 * @param name the name of the field
 * @param type the type of the field
 * @param description the description of the field
 * @return newly created SerialFieldTree
 * @since 0.124
 */
public SerialFieldTree SerialField(com.sun.source.doctree.IdentifierTree name, ReferenceTree type, List<? extends DocTree> description) {
    return delegate.SerialField(name, type, description);
}
 

/**
 * Create a new {@code SerialFieldTree} object, to represent a {@code @serialField } tag.
 * @param name the name of the field
 * @param type the type of the field
 * @param description the description of the field
 * @return a {@code SerialFieldTree} object
 */
SerialFieldTree newSerialFieldTree(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description);