/** * Build the serial UID information for the given class. */ public void buildSerialUIDInfo() { FieldDoc[] fields = currentClass.fields(false); for (int i = 0; i < fields.length; i++) { if (fields[i].name().equals("serialVersionUID") && fields[i].constantValueExpression() != null) { writer.writeSerialUIDInfo(SERIAL_VERSION_UID_HEADER, fields[i].constantValueExpression()); return; } } }
/** * Return true if the given class has constant fields to document. * * @param classDoc the class being checked. * @return true if the given package has constant fields to document. */ private boolean hasConstantField (ClassDoc classDoc) { VisibleMemberMap visibleMemberMapFields = new VisibleMemberMap(classDoc, VisibleMemberMap.FIELDS, configuration.nodeprecated); List<?> fields = visibleMemberMapFields.getLeafClassMembers(configuration); for (Iterator<?> iter = fields.iterator(); iter.hasNext(); ) { FieldDoc field = (FieldDoc) iter.next(); if (field.constantValueExpression() != null) { classDocsWithConstFields.add(classDoc); return true; } } return false; }
/** * Return true if the given class has constant fields to document. * * @param classDoc the class being checked. * @return true if the given package has constant fields to document. */ private boolean hasConstantField (ClassDoc classDoc) { VisibleMemberMap visibleMemberMapFields = new VisibleMemberMap(classDoc, VisibleMemberMap.FIELDS, configuration); List<?> fields = visibleMemberMapFields.getLeafClassMembers(configuration); for (Iterator<?> iter = fields.iterator(); iter.hasNext(); ) { FieldDoc field = (FieldDoc) iter.next(); if (field.constantValueExpression() != null) { classDocsWithConstFields.add(classDoc); return true; } } return false; }
... private Content getValue(FieldDoc member) { Content valueContent; if ("char".equals(member.type().toString())) { valueContent = new StringContent("'" + (char) ((Integer) member.constantValue()).intValue() + "'" ); } else { valueContent = new StringContent(member.constantValueExpression()); } Content code = HtmlTree.CODE(valueContent); return HtmlTree.TD(HtmlStyle.colLast, code); } ...
/** * Get the value column for the constant summary table row. * * @param member the field to be documented. * @return the value column of the constant table row */ private Content getValue(FieldDoc member) { Content valueContent = new StringContent(member.constantValueExpression()); Content code = HtmlTree.CODE(valueContent); return HtmlTree.TD(HtmlStyle.colLast, code); }
/** * Build the serial UID information for the given class. * * @param node the XML element that specifies which components to document * @param classTree content tree to which the serial UID information will be added */ public void buildSerialUIDInfo(XMLNode node, Content classTree) { Content serialUidTree = writer.getSerialUIDInfoHeader(); FieldDoc[] fields = currentClass.fields(false); for (int i = 0; i < fields.length; i++) { if (fields[i].name().equals("serialVersionUID") && fields[i].constantValueExpression() != null) { writer.addSerialUIDInfo(SERIAL_VERSION_UID_HEADER, fields[i].constantValueExpression(), serialUidTree); break; } } classTree.addContent(serialUidTree); }
private void writeValue(FieldDoc member) { tdAlign("right"); code(); print(Util.escapeHtmlChars(member.constantValueExpression())); codeEnd(); tdEnd(); } }
protected Field parseField(FieldDoc fieldDoc) { Field fieldNode = objectFactory.createField(); fieldNode.setType(parseTypeInfo(fieldDoc.type())); fieldNode.setName(fieldDoc.name()); fieldNode.setQualified(fieldDoc.qualifiedName()); String comment = fieldDoc.commentText(); if (comment.length() > 0) { fieldNode.setComment(comment); } fieldNode.setScope(parseScope(fieldDoc)); fieldNode.setFinal(fieldDoc.isFinal()); fieldNode.setStatic(fieldDoc.isStatic()); fieldNode.setVolatile(fieldDoc.isVolatile()); fieldNode.setTransient(fieldDoc.isTransient()); fieldNode.setConstant(fieldDoc.constantValueExpression()); for (AnnotationDesc annotationDesc : fieldDoc.annotations()) { fieldNode.getAnnotation().add(parseAnnotationDesc(annotationDesc, fieldDoc.qualifiedName())); } for (Tag tag : fieldDoc.tags()) { fieldNode.getTag().add(parseTag(tag)); } return fieldNode; }
/** * {@inheritDoc} */ public TagletOutput getTagletOutput(Tag tag, TagletWriter writer) { FieldDoc field = getFieldDoc( writer.configuration(), tag, tag.text()); if (field == null) { //Reference is unknown. writer.getMsgRetriever().warning(tag.holder().position(), "doclet.value_tag_invalid_reference", tag.text()); } else if (field.constantValue() != null) { return writer.valueTagOutput(field, Util.escapeHtmlChars(field.constantValueExpression()), ! field.equals(tag.holder())); } else { //Referenced field is not a constant. writer.getMsgRetriever().warning(tag.holder().position(), "doclet.value_tag_invalid_constant", field.name()); } return writer.getOutputInstance(); } }
/** * {@inheritDoc} */ public Content getTagletOutput(Tag tag, TagletWriter writer) { FieldDoc field = getFieldDoc( writer.configuration(), tag, tag.text()); if (field == null) { if (tag.text().isEmpty()) { //Invalid use of @value writer.getMsgRetriever().warning(tag.holder().position(), "doclet.value_tag_invalid_use"); } else { //Reference is unknown. writer.getMsgRetriever().warning(tag.holder().position(), "doclet.value_tag_invalid_reference", tag.text()); } } else if (field.constantValue() != null) { return writer.valueTagOutput(field, field.constantValueExpression(), ! field.equals(tag.holder())); } else { //Referenced field is not a constant. writer.getMsgRetriever().warning(tag.holder().position(), "doclet.value_tag_invalid_constant", field.name()); } return writer.getOutputInstance(); } }
initialValue = fieldDoc.constantValueExpression(); if ( initialValue != null && !initialValue.equals("") ) { initialValueExpression = factory.constructExpression( initialValue );