Java Doc for AbstractMemberWriter.java in  » 6.0-JDK-Modules-com.sun » tools » com » sun » tools » doclets » formats » html » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules com.sun » tools » com.sun.tools.doclets.formats.html 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.sun.tools.doclets.formats.html.AbstractMemberWriter

All known Subclasses:   com.sun.tools.doclets.formats.html.NestedClassWriterImpl,  com.sun.tools.doclets.formats.html.AnnotationTypeRequiredMemberWriterImpl,  com.sun.tools.doclets.formats.html.EnumConstantWriterImpl,  com.sun.tools.doclets.formats.html.AbstractExecutableMemberWriter,  com.sun.tools.doclets.formats.html.FieldWriterImpl,
AbstractMemberWriter
abstract public class AbstractMemberWriter (Code)
The base class for member writers.
author:
   Robert Field
author:
   Atul M Dambalkar
author:
   Jamie Ho (Re-write)


Field Summary
final protected  ClassDocclassdoc
    
final public  booleannodepr
    
protected  booleanprintedSummaryHeader
    
final protected  SubWriterHolderWriterwriter
    

Constructor Summary
public  AbstractMemberWriter(SubWriterHolderWriter writer, ClassDoc classdoc)
    
public  AbstractMemberWriter(SubWriterHolderWriter writer)
    

Method Summary
protected  voidbold(String str)
    
public  ConfigurationImplconfiguration()
    
public  ProgramElementDoc[]eligibleMembers(ProgramElementDoc[] members)
    
protected  booleanisInherited(ProgramElementDoc ped)
     Return true if the given ProgramElement is inherited by the class that is being documented.
protected  StringmakeSpace(int len)
    
protected  StringmodifierString(MemberDoc member)
     Return a string describing the access modifier flags.
protected  Stringname(ProgramElementDoc member)
    
protected  voidnavDetailLink(List members)
    
protected  voidnavSummaryLink(List members, VisibleMemberMap visibleMemberMap)
    
protected  voidprint(String str)
    
protected  voidprint(char ch)
    
protected  voidprintComment(ProgramElementDoc member)
    
protected  voidprintCommentAndTags(ProgramElementDoc member)
    
protected  voidprintDeprecatedAPI(List deprmembers, String headingKey)
     Generate the code for listing the deprecated APIs.
protected  voidprintFullComment(ProgramElementDoc member)
    
protected  voidprintHead(MemberDoc member)
    
abstract public  voidprintInheritedSummaryAnchor(ClassDoc cd)
    
public  voidprintInheritedSummaryFooter(ClassDoc cd)
    
public  voidprintInheritedSummaryHeader(ClassDoc cd)
    
abstract public  voidprintInheritedSummaryLabel(ClassDoc cd)
    
protected  voidprintModifierAndType(ProgramElementDoc member, Type type)
     Print the modifier and type for the member in the member summary.
protected  voidprintModifiers(MemberDoc member)
    
abstract protected  voidprintNavDetailLink(boolean link)
    
abstract protected  voidprintNavSummaryLink(ClassDoc cd, boolean link)
    
protected  voidprintStaticAndType(boolean isStatic, Type type)
     Print 'static' if static and type link.
abstract public  voidprintSummaryAnchor(ClassDoc cd)
    
public  voidprintSummaryFooter(ClassDoc cd)
    
public  voidprintSummaryHeader(ClassDoc cd)
    
abstract public  voidprintSummaryLabel(ClassDoc cd)
    
abstract protected  voidprintSummaryType(ProgramElementDoc member)
    
protected  voidprintUseInfo(Object mems, String heading)
     Print use info.
protected  voidserialWarning(SourcePosition pos, String key, String a1, String a2)
    
protected  StringtypeString(MemberDoc member)
    
abstract protected  voidwriteDeprecatedLink(ProgramElementDoc member)
    
abstract protected  voidwriteInheritedSummaryLink(ClassDoc cd, ProgramElementDoc member)
    
public  voidwriteMemberSummary(ClassDoc classDoc, ProgramElementDoc member, Tag[] firstSentenceTags, boolean isFirst, boolean isLast)
    
protected  voidwriteSummaryLink(ClassDoc cd, ProgramElementDoc member)
    
abstract protected  voidwriteSummaryLink(int context, ClassDoc cd, ProgramElementDoc member)
    

Field Detail
classdoc
final protected ClassDoc classdoc(Code)



nodepr
final public boolean nodepr(Code)



printedSummaryHeader
protected boolean printedSummaryHeader(Code)



writer
final protected SubWriterHolderWriter writer(Code)




Constructor Detail
AbstractMemberWriter
public AbstractMemberWriter(SubWriterHolderWriter writer, ClassDoc classdoc)(Code)



AbstractMemberWriter
public AbstractMemberWriter(SubWriterHolderWriter writer)(Code)




Method Detail
bold
protected void bold(String str)(Code)



configuration
public ConfigurationImpl configuration()(Code)



eligibleMembers
public ProgramElementDoc[] eligibleMembers(ProgramElementDoc[] members)(Code)



isInherited
protected boolean isInherited(ProgramElementDoc ped)(Code)
Return true if the given ProgramElement is inherited by the class that is being documented.
Parameters:
  ped - The ProgramElement being checked.return true if the ProgramElement is being inherited andfalse otherwise.



makeSpace
protected String makeSpace(int len)(Code)



modifierString
protected String modifierString(MemberDoc member)(Code)
Return a string describing the access modifier flags. Don't include native or synchronized. The modifier names are returned in canonical order, as specified by The Java Language Specification.



name
protected String name(ProgramElementDoc member)(Code)



navDetailLink
protected void navDetailLink(List members)(Code)



navSummaryLink
protected void navSummaryLink(List members, VisibleMemberMap visibleMemberMap)(Code)



print
protected void print(String str)(Code)



print
protected void print(char ch)(Code)



printComment
protected void printComment(ProgramElementDoc member)(Code)



printCommentAndTags
protected void printCommentAndTags(ProgramElementDoc member)(Code)



printDeprecatedAPI
protected void printDeprecatedAPI(List deprmembers, String headingKey)(Code)
Generate the code for listing the deprecated APIs. Create the table format for listing the API. Call methods from the sub-class to complete the generation.



printFullComment
protected void printFullComment(ProgramElementDoc member)(Code)



printHead
protected void printHead(MemberDoc member)(Code)



printInheritedSummaryAnchor
abstract public void printInheritedSummaryAnchor(ClassDoc cd)(Code)



printInheritedSummaryFooter
public void printInheritedSummaryFooter(ClassDoc cd)(Code)
Forward to containing writer



printInheritedSummaryHeader
public void printInheritedSummaryHeader(ClassDoc cd)(Code)
Forward to containing writer



printInheritedSummaryLabel
abstract public void printInheritedSummaryLabel(ClassDoc cd)(Code)



printModifierAndType
protected void printModifierAndType(ProgramElementDoc member, Type type)(Code)
Print the modifier and type for the member in the member summary.
Parameters:
  member - the member to print the type for.
Parameters:
  type - the type to print.



printModifiers
protected void printModifiers(MemberDoc member)(Code)



printNavDetailLink
abstract protected void printNavDetailLink(boolean link)(Code)



printNavSummaryLink
abstract protected void printNavSummaryLink(ClassDoc cd, boolean link)(Code)



printStaticAndType
protected void printStaticAndType(boolean isStatic, Type type)(Code)
Print 'static' if static and type link.



printSummaryAnchor
abstract public void printSummaryAnchor(ClassDoc cd)(Code)



printSummaryFooter
public void printSummaryFooter(ClassDoc cd)(Code)
Forward to containing writer



printSummaryHeader
public void printSummaryHeader(ClassDoc cd)(Code)
Forward to containing writer



printSummaryLabel
abstract public void printSummaryLabel(ClassDoc cd)(Code)
abstracts **



printSummaryType
abstract protected void printSummaryType(ProgramElementDoc member)(Code)



printUseInfo
protected void printUseInfo(Object mems, String heading)(Code)
Print use info.



serialWarning
protected void serialWarning(SourcePosition pos, String key, String a1, String a2)(Code)



typeString
protected String typeString(MemberDoc member)(Code)



writeDeprecatedLink
abstract protected void writeDeprecatedLink(ProgramElementDoc member)(Code)



writeInheritedSummaryLink
abstract protected void writeInheritedSummaryLink(ClassDoc cd, ProgramElementDoc member)(Code)



writeMemberSummary
public void writeMemberSummary(ClassDoc classDoc, ProgramElementDoc member, Tag[] firstSentenceTags, boolean isFirst, boolean isLast)(Code)



writeSummaryLink
protected void writeSummaryLink(ClassDoc cd, ProgramElementDoc member)(Code)



writeSummaryLink
abstract protected void writeSummaryLink(int context, ClassDoc cd, ProgramElementDoc member)(Code)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.