The following table holds the "pretty.settings" file contents, ordered by the order in which they were added to the file.
| tag |
default |
since |
comments |
examples |
| version |
4.4 |
2.6 |
Version |
version=4.4 |
| indent | 3 | 2.6 | This is the number of characters to indent for each block. | indent=4 |
| indent.char | space | 2.6 | The character used to indent each block tab - use tabs to indent space - use spaces to indent |
indent.char=tab |
| expr.space | false | 2.6 | This parameter should be changed to true if you
like your parens to have a space before and after them # if ( x == y ) //expr.space=true # if (x == y) //expr.space=false |
expr.space=false |
| lines.between | 2 | 2.6 | The following parameter is the minimum number of blank
lines between methods, nested classes, and nested
interfaces. It is also the number of lines before and
after field declarations, though field declarations
will have what ever spacing you used. Note that this is a minimum. If your code already has more space between methods, then it won't shrink the number of blank lines. |
lines.between=1 |
| cast.space | false | 2.6 | Is there a space after the cast | cast.space=true |
| cast.force.nospace | false | 2.6 (3.4) | Do we force a space after a cast? | cast.force.nospace=true |
| surprise.return | double | 2.6 (2.2) | Defines what the pretty does when a newline is unexpectedly encountered. double - The pretty printer inserts 2 indents single - The pretty printer inserts 1 indent param - Like single, except method arguments are indented to the parens |
surprise.return=single |
| throws.newline | false | 2.6 (2.2) | Defines whether the throws part of a method/constructor declaration always be on its own line | throws.newline=true |
| catch.start.line | false | 2.6 | When the catch.start.line setting is true, catch statements look like this: try { // Something here } catch (IOException ioe) { // Something here } When the catch.start.line setting is false, catch statements look like: try { // Something here } catch (IOException ioe) { // Something here } |
catch.start.line=false |
| else.start.line | false | 2.6 | Should if/then/else statements look like (when true): if (someTest()) { // Something here } else { // Something here } (when false): if (someTest()) { // Something here } else { // Something here } |
else.start.line=true |
| field.name.indent | -1 | 2.6 (3.0) | Indent the name of the field (instance variable or class variable) to this column (-1 for just one space) | field.name.indent=8 |
| end.line | NL | 2.6 (3.0) updated 2.9.15 |
End of line character(s) - either CR, CRNL, or NL CR - carriage return LF - newline/linefeed NL - newline (=LF) CRNL - carriage return and newline CRLF - carriage return and line feed (=CRNL) MAC - mac carriage return UNIX - unix newline DOS - carriage return and newline ASIS - leave line endings alone - NOT IMPLEMENTED |
end.line=CRLF |
| variable.spacing | single | 2.6 (3.0) | This features sprecifies how to space out a field or
a local variable declaration. single - a space between the modifiers, the type, the name and the initializer. dynamic - determine the spacing between the modifiers, type, name, and initializers so everything lines up. javadoc.dynamic - determine the spacing between the modifiers, type, name, and initializers so everything lines up, except when the field is prefixed by a javadoc comment. align.equals - align the equals statements of field declaration, but nothing else |
variable.spacing=align.equals |
| dynamic.variable.spacing | 1 | 2.6 (3.1) | When a dynamic field spacing is used, this value specifies the number of additional spaces to add between the modifiers, type, name, and initializer. | dynamic.variable.spacing=2 |
| variable.align.with.block | false | 2.6 (3.7) | Should the local variables be aligned with the { and }
or should they be indented to align with the other code? false means align with the code, true means align with the { } |
variable.align.with.block=true |
| case.indent | 4 | 2.6 (3.8) | The amount to indent a case statement (in terms of indent.char) | case.indent=3 |
| keyword.space | true | 2.6 | This determines if there should be a space after
keywords such as if, while, or for. When this value
is true, you get: if (true) { // Do something } When this value is false, you get: if(true) { // Do something } |
keyword.space=false |
| insert.space.around.local.variables | false | 2.6 | Is a blank line forced before and after local variable declarations? | insert.space.around.local.variables=true |
| lines.after.package | 1 | 2.6 | This is the number of lines to insert after a package statement. | lines.after.package=2 |
| maintain.newlines.around.imports | true | 2.6 | Are all the newlines kept around imports? | maintain.newlines.around.imports=false |
| lines.before.class | 1 | 2.6 | This is the number of lines to insert before a class. | lines.before.class=2 |
| block.style | C | 2.6 | Style for { and } C style means that { is at the end of the line and } is on a line by itself. For example: if (myTest) { // This is c style } PASCAL style means both { and } are on lines by themselves. For example: if (myTest) { // This is PASCAL style } EMACS style means both { and } are on lines by themselves and indented one level. For example: if (myTest) { // This is EMACS style } C - C style PASCAL - PASCAL style EMACS - EMACS style |
block.style=PASCAL |
| method.block.style | C | 2.6 (2.2) | To handle sun's coding standard, you want the method
to begin with a PASCAL coding style and the {}
beneath that to be C style. This parameter allows you to set the method style different from the rest. C - C style PASCAL - PASCAL style EMACS - EMACS style |
method.block.style=C |
| class.block.style | C | 2.6 (2.2) | To handle sun's coding standard, you want the class
to begin with a PASCAL coding style and the {}
beneath that to be C style. This parameter allows you to set the class style different from the rest. C - C style PASCAL - PASCAL style EMACS - EMACS style |
class.block.style=C |
| force.block | false | 2.6 | Are if and while and for statements forced to have a block? | force.block=true |
| empty.block.single.line | true | 2.6 (3.3) | Empty methods and constructors remain on a single line. | empty.block.single.line=false |
| remove.excess.blocks | false | 2.6 | Remove {} when they surround only 1 statement. | remove.excess.blocks=true |
| singleline.comment.ownline | true | 2.6 (3.0) | Should each single line comment be indented a certain number of spaces from the margin? For this to work right be sure to indent each line with spaces. | singleline.comment.ownline=true |
| singleline.comment.absoluteindent | 0 | 2.6 (3.0) | Absolute indent before a single line comment. | singleline.comment.absoluteindent=20 |
| singleline.comment.incrementalindent | 0 | 2.6 (3.0) | Space used before the start of a single line from the end of the code. This value is used to determine the number of spaces and how these spaces are used based on the next few settings. | singleline.comment.incrementalindent=2 |
| singleline.comment.indentstyle.shared | incremental | 2.6 (3.0) | This feature describes how the pretty printer should
indent single line comments (//) that share the line
with source code. The two choices are incremental
and absolute. incremental - use an incremental indent< absolute - use the absolute indent level |
singleline.comment.indentstyle.shared= absolute |
| singleline.comment.indentstyle.ownline | code | 2.6 (3.0) | This feature describes how the pretty printer should
indent single line comments (//) that are on their
own line. The two choices are code and absolute. code - use the same indent as the current code absolute - use the absolute indent level |
singleline.comment.indentstyle.ownline= absolute |
| c.style.format | leave | 2.6 (3.2) | How to format C Style comments. Valid values are: leave - leave alone maintain.space.star - there is a row of stars to the right, but we maintain the spaces after it. align.star - place a row of stars to the right and align on those align.blank - just align the comments to the right (no star) |
c.style.format=align.star |
| c.style.indent | 2 | 2.6 (3.2) | For one of the methods above that use the align type, this is the number of spaces to include after the * or blank | c.style.indent=1 |
| method.minimum | all | 2.6 | Limits the level that javadoc comments are forced
into the document. method.minimum applies
to constructors and methods. The following are valid
levels: all - all items must have javadoc private - same as all package - all items except private items must have javadoc default - same as package protected - protected and public items must have javadoc public - only public items must have javadoc none - nothing is required to have javadoc |
method.minimum=none |
| field.minimum | protected | 2.6 | Limits the level that javadoc comments are forced
into the document. field.minimum applies to
fields. The following are valid levels: all - all items must have javadoc private - same as all package - all items except private items must have javadoc default - same as package protected - protected and public items must have javadoc public - only public items must have javadoc none - nothing is required to have javadoc |
field.minimum=package |
| class.minimum | all | 2.6 | Limits the level that javadoc comments are forced
into the document. class.minimum applies to
classes and interfaces. The following are valid levels: all - all items must have javadoc private - same as all package - all items except private items must have javadoc default - same as package protected - protected and public items must have javadoc public - only public items must have javadoc none - nothing is required to have javadoc |
class.minimum=public |
| javadoc.star | 2 | 2.6 | Star count for javadoc | javadoc.star=2 |
| javadoc.wordwrap.max | 80 | 2.6 | Wordwrap length for javadoc. If the sum of the number of characters on the line exceeds this value, then the javadoc comment will be wordwrapped. | javadoc.wordwrap.max=120 |
| javadoc.wordwrap.min | 40 | 2.6 | This feature keeps a method that is deeply indented from only having a few words on each line. This feature requires that there be this many characters after the comment starts before the javadoc comment is wordwrapped. | javadoc.wordwrap.min=60 |
| space.before.javadoc | true | 2.6 | Controls whether a space is put before the @ in Javadoc comments | space.before.javadoc=false |
| javadoc.id.lineup | true | 2.6 | Should the names and descriptions in javadoc comments be lined up? | javadoc.id.lineup=false |
| javadoc.indent | 2 | 2.6 (2.2) | The number of spaces javadoc comments should be indented by. | javadoc.indent=1 |
| reformat.comments | true | 2.6 (3.0) | Wordwrap the javadoc comments | reformat.comments=false |
| exception.tag.name | @exception | 2.6 (3.5) | What tag name should be used for exceptions. | exception.tag.name=@throws |
| document.nested.classes | true | 2.6 (3.6) | Should inner classes be documented | document.nested.classes=false |
| allow.singleline.javadoc | true | 2.6 | Are javadoc comments allowed to be a single line long | allow.singleline.javadoc=false |
| keep.all.javadoc | false | 2.6 (3.0) | Include javadoc comments where ever they appear. Javadoc comments were originally only allowed to occur at a few places: immediately before a method, immediately before a field, and immediately before a class or interface. Since it is also common for people to include the /*** pattern at the beginning of a file, this will be preserved as well. This was the case until JBuilder pressed the javadoc style comment into a new line of work - handling @todo tags. to include javadoc comments anywhere in the file. With keep.all.javadoc set to false, you get the original behavior. All javadoc comments that were not in the correct place were cleaned up for you. With this set to true, you can place the @todo tags wherever you please. | keep.all.javadoc=true |
| class.descr | Description of the Class | 2.6 | Default description of the class. | class.descr=Undocumented |
| interface.descr | Description of the Interface | 2.6 | Default description of the interface. | interface.descr=An Interface |
| constructor.descr | Constructor for the {0} object | 2.6 | Default description of the constructor {0} stands for the name of the constructor | constructor.descr={0} constructor. |
| method.descr | Description of the Method | 2.6 | Default description of the method. | method.descr=Document this method |
| getter.descr | Gets the {3} attribute of the {1} {2} | 2.6 | Default description of the getter. {0} is the name of the attribute, {1} is the name of the class, {2} is 'class' or 'object' depending on whether it is static or not, {3} is the name of the attribute with the first letter lowercased {4} is the name of the attribute broken into words |
getter.descr=Gets the {4} attribute of the {1} {2} |
| getter.return.descr | The {3} value | 2.6 | Return description for getters. {0} is the name of the attribute, {3} is the name of the attribute with the first letter lowercased {4} is the name of the attribute broken into words |
getter.return.descr=The {4} value |
| setter.descr | Sets the {3} attribute of the {1} {2} | 2.6 | Default description of the setter. {0} is the name of the attribute, {1} is the name of the class, {2} is 'class' or 'object' depending on whether it is static or not, {3} is the name of the attribute with the first letter lowercased {4} is the name of the attribute broken into words |
setter.descr=Sets the {4} attribute of the {1} {2} |
| setter.param.descr | The new {3} value | Parameter description for setters. {0} is the name of the attribute, {3} is the name of the attribute with the first letter lowercased< {4} is the name of the attribute broken into words |
setter.param.descr=The new {4} value | |
| field.descr | Description of the Field | 2.6 | Default field description | field.descr=Description of the member variable |
| run.descr | Main processing method for the {1} {2} | 2.6 | Default description of the run method. {0} is not applicable, {1} is the name of the class, {2} is 'class' or 'object' depending on whether it is static or not. |
run.descr={1} run method. |
| main.descr | The main program for the {1} {2} | 2.6 | Default description of the main method. {0} is not applicable, {1} is the name of the class, {2} is 'class' or 'object' depending on whether it is static or not. |
main.descr={1} main method. |
| main.param.descr | The command line arguments | 2.6 | Description of the main arguments | main.param.descr=Command line arguments |
| adder.descr | Adds a feature to the {3} attribute of the {1} {2} | 2.6 | Default description of the add() method. {0} is the name of the attribute, {1} is the name of the class, {2} is 'class' or 'object' depending on whether it is static or not, {3} is the name of the attribute with the first letter lowercased |
adder.descr=Adds a feature to the {3} attribute of the {1} {2} |
| adder.param.descr | The feature to be added to the {3} attribute | 2.6 | Description of the add argument {0} is the name of the attribute, {3} is the name of the attribute with the first letter lowercased< {4} is the name of the attribute broken into words |
adder.param.descr=The feature to be added to the {3} attribute. |
| junit.setUp.descr | The JUnit setup method | 2.6 | JUnit has a particular format for the names of methods. These setup for the unit tests are done in a method named setUp, the cleanup afterwards is done in tearDown, and the unit tests all start with the word test. The following are the default descriptions of these methods. | junit.setUp.descr=The JUnit setup method |
| junit.test.descr | A unit test for JUnit | 2.6 | junit.test.descr=A unit test for JUnit | |
| junit.tearDown.descr | The teardown method for JUnit | 2.6 | junit.tearDown.descr=The teardown method for JUnit | |
| >junit.suite.descr | A unit test suite for JUnit | 2.6 | junit.suite.descr=A unit test suite for JUnit | |
| junit.suite.return.descr | The test suite | 2.6 | junit.suite.return.descr | |
| author.descr | {0} | 2.6 | The following are the tags and the order that are required in javadocs. If there is description, then they are not required and the system is only specifying the order in which they should appear. If a description is provided, then the tag is required. | author.descr={0} |
| created.descr | {1} | 2.6 | created.descr={1} | |
| param.descr | Description of the Parameter | 2.6 | param.descr=Description of the Parameter | |
| return.descr | Description of the Return Value | 2.6 | return.descr=Description of the Return Value | |
| exception.descr | Description of the Exception | 2.6 | exception.descr=Description of the Exception | |
| class.tags | author,created | 2.6 | class.tags=author | |
| method.tags | param,return,exception,since | 2.6 | method.tags=param,return,exception,since | |
| field.tags | since | 2.6 | field.tags=since | |
| char.stream.type | 1 | 2.6 (3.0) | This feature describes what type of characters are
used for the java files. 1 - ASCII (1 byte characters) 2 - Unicode (2 byte characters - far east) 3 - ASCII full (2 byte characters - far east) |
char.stream.type=2 |
| pretty.printer.backup.ext | 2.6 (3.8) | If you would like the pretty printer to make a backup of the file before applying the pretty printer to the file, add an extension here. | pretty.printer.backup.ext=bck~ | |
| header.1 header.2 header.3 |
/* This is the header */ |
2.6 | Insert the header Add any amount of lines here, numbered sequentially. |
header.1=/* header.2=Copyright Mike Atkinson header.3=*/ |
| footer.1 | /******** End of document *****/ | 2.6 (3.6) | Insert the footer | footer.1=/******** End of document *****/ |
| sort.top | true | 2.6 | Should the types and imports be sorted | sort.top=false |
| import.sort.important | java,javax | 2.7 (3.9) | List the prefixes of imports that should be sorted to the top. For instance: java,javax,org.w3c | import.sort.important=org.apache |
| import.sort.neighbourhood | 0 | 2.6 | If you want classes that are written by you to move
to the end of the list of imports change this value. 0 - Keep all the imports in alphabetical order 1 - If the package and the import start with the same value - com or org - put them at the end 2 - When package and import share 2 directory levels, the imports are listed last |
import.sort.neighbourhood=1 |
| sort.1 sort.2 sort.3 sort.4 sort.5 sort.6 sort.7 |
Type(Field,Constructor, Method,NestedClass, NestedInterface,Initializer) Method(setter,getter,other) Final(top) Protection(public) Class(Static,Instance) Alphabetical() FieldInitializers() |
The following controls the order of methods, fields,
classes, etc inside a class. If you don't want to sort by any of these criterias, simply comment them out, but make sure that the remaining sort options are numbered sequentially. |
sort.1=Protection(public) sort.2=Final(bottom) sort.3=Type(Initializer,NestedInterface, NestedClass,Constructor, Method,Field) sort.4=Method(setter,getter,other) sort.5=Class(Static,Instance) sort.6=Alphabetical() sort.7=FieldInitializers() |
|
| sort.1 | Type(Field,Constructor, Method,NestedClass, NestedInterface,Initializer) |
2.6 | This orders the items in the class by their type. The items to order are fields, constructors, methods, nested classes, nested interfaces, and initializers | sort.1=Type(Initializer,NestedInterface, NestedClass,Constructor, Method,Field) |
| sort.2 | Method(setter,getter,other) | 2.6 | Order getters, setters, and then other methods. Setters are methods that start with the word 'set'. Getters are methods that start with the word 'get' or 'is' |
sort.2=Method(other,setter,getter) |
| sort.3 | Final(top) | 2.6 | How final methods and fields should be sorted Final(top) - Move to the top Final(bottom) - Move to the bottom |
sort.3=Final(bottom) |
| sort.4 | Protection(public) | 2.6 | How the protection should be used to sort fields and methods. Protection(public) - Move public to the top. Protection(private) - Move private to the top |
sort.4=Protection(public) |
| sort.5 | Class(Static,Instance) | 2.6 (3.8) | How static methods and fields should be sorted< Class(Static,Instance) - Move static to the top Class(Instance,Static) - Move static to the bottom |
sort.5=Class(Static,Instance) |
| sort.6 | Alphabetical() | 2.6 (3.8) | Order methods and fields in alphabetical order. | sort.6=Alphabetical() |
| sort.7 | FieldInitializers() | 2.6 (3.8) | Maintain the order of fields with initializers | sort.7=FieldInitializers() |
| enum.descr | Description of the Enumeration | 2.7 (3.9) | Default description of an enumeration | enum.descr=Description of the Enumeration |
| enum.tags | autho | 2.7 (3.9) | Tags for an enumeration | enum.tags=autho |
| tagDescr.author | Mike Atkinson | 2.6 | Tag description for @author | tagDescr.author=Your Name |
| tagDescr.since | 2.6 | Tag description for @since | tagDescr.since= | |
| pmd.path | 2.7 | File path to custom coding standard rules. | pmd.path= | |
| pmd.ask.for.directory | true | 2.7 | If not selected then take the directory from the current directory of the file system browser (if available). If selected or there is no VFS browser then popup a dialog asking for a directory to scan. | pmd.ask.for.directory=false |
| pmd.min.tile.size | 100 | 2.7 | Determines how big a region of matching code the Cut and Paste detector finds. Smaller numbers find smaller sections of matching code, values between 5 and 200 seem to work best. | pmd.min.tile.size=20 |
| formatOnSave | false | 2.7 | If true, the current buffer will automatically be formatted by JavaStyle when the buffer is saved. | formatOnSave=true |
| checkOnSave | false | 2.7 | If true, the current buffer will automatically be checked by the Coding Standards Checker when the buffer is saved. | checkOnSave=true |
| sort.protection | public | 2.7? | This is used by the IDE plugin to maintain the sort order for protection, independently from the where protection ordering is performed in the sort chain (see "sort.n"). | sort.protection=public |
| sort.final | bottom | 2.7? | This is used by the IDE plugin to maintain the sort order for final fields and methods, independently from the where final ordering is performed in the sort chain (see "sort.n"). | sort.final=bottom |
| sort.class | Instance,Static | 2.7? | This is used by the IDE plugin to maintain the sort order for classes, independently from the where class ordering is performed in the sort chain (see "sort.n"). | sort.class=Instance,Static |
| sort.type | Field,Constructor,Method, NestedClass,NestedInterface, Initializer |
2.7? | This is used by the IDE plugin to maintain the sort order for types, independently from the where type ordering is performed in the sort chain (see "sort.n"). | sort.type=Field,Constructor, Method,NestedClass,NestedInterface, Initializer |
| sort.method | setter,getter,other | 2.7? | This is used by the IDE plugin to maintain the sort order for methods, independently from the where method ordering is performed in the sort chain (see "sort.n"). | sort.method=setter,getter,other |
| params.lineup | true | 2.6? | Align parameters with the first parameter public void foo(int a, String b, final String c) { } |
params.lineup=false |
| jdk | 1.4.2 | 2.7 (3.9) | This is the Java Development Kit version (e.g. "1.4.2") to use as the target (this may be different than the JDK running the application). | jdk=1.5.0 |
| cstyle.comment.ownline | true | 2.7 (3.9) | Treat C-Style comments as single-line: If checked, C-Style comments appended at the end of a source code line are treated the same way as double slash comments. E.g. Code like this: String s = "hello"; /* init s */ does not get formated to this: String s = "hello"; /* init s */ if single-line comments remain at the end of the line. |
cstyle.comment.ownline=false |
| enum.minimum | none | 2.7 (3.9) | Limits the level that javadoc comments are forced
into the document. enum.minimum applies to
enumerations. The following are valid levels: all - all items must have javadoc private - same as all package - all items except private items must have javadoc default - same as package protected - protected and public items must have javadoc public - only public items must have javadoc< none - nothing is required to have javadoc |
enum.minimum=package |
| javadoc.tag.indent | (3.9) | How many spaces should main description in javadoc comments be indented? | javadoc.tag.indent= | |
| #insert.space.around.local.variables | (4.0) | Additional blank lines before and after local variable
declarations. Commented out by default. |
insert.space.around.local.variables=false | |
| #remove.excess.blocks | (4.0) | Remove brackets around single-line blocks. Commented out by default. |
remove.excess.blocks=false | |
| #else.start.line=false | (4.0) | 'else' starts on a new line. Commented out by default. |
else.start.line=false | |
| #allow.singleline.javadoc | (4.0) | Allow single line JavaDoc comments. If true then the JUnit tests fail. Commented out by default. |
#allow.singleline.javadoc=true | |
| tostring.descr | Converts to a String representation of the {0} object | (4.1) | Default description of the toString() method. | tostring.descr=Converts to a String representation of the {0} object |
| tostring.return.descr | A string representation of the {0} object. | (4.1) | Default description of the toString() method. | tostring.return.descr=A string representation of the {0} object. |
| equals.descr | Compares this {0} to the parameter. | (4.1) | Default description of the equals(Object) method. | equals.descr=Compares this {0} to the parameter. |
| equals.param.descr | the reference object with which to compare. | (4.1) | Default description of the equals(Object) method. | equals.param.descr=the reference object with which to compare. |
| equals.return.descr | true if this object is the same as the obj argument; false otherwise. | (4.1) | Default description of the equals(Object) method. | equals.return.descr=true if this object is the same as the obj argument; false otherwise. |
| hashcode.descr | Computes a hash value for this {0} object. | (4.1) | Default description of the hashCode method. | hashcode.descr=Computes a hash value for this {0} object. |
| hashcode.return.descr | The hash value for this {0} object. | (4.1) | Default description of the hashCode method. | hashcode.return.descr=The hash value for this {0} object. |
| clone.descr | Creates an exact copy of this {0} object. | (4.1) | Default description of the clone() method. | clone.descr=Creates an exact copy of this {0} object. |
| clone.return.descr | A clone of this {0} object. | (4.1) | Default description of the clone() method. | clone.return.descr=A clone of this {0} object. |
| copyconstructor.descr | Copy constructor for the {0} object. Creates a copy of the {0} object parameter. | (4.1) | Default description of the copy constructor, {0} stands for the name of the constructor. | copyconstructor.descr=Copy constructor for the {0} object. Creates a copy of the {0} object parameter. |
| copyconstructor.param.descr | Object to copy. | (4.1) | Default description of the copy constructor, {0} stands for the name of the constructor. | copyconstructor.param.descr=Object to copy. |
| finalize.descr | Overrides the finalize method to dispose of system resources or to perform other cleanup when the {1} object is garbage collected. | (4.1) | Default description of the finalize() method, {1} stands for the name of the class. | finalize.descr=Overrides the finalize method to dispose of system resources or to perform other cleanup when the {1} object is garbage collected. |
| listener.add.descr | Adds the specified {0} listener to receive {0} events from this component. If listener l is null, no exception is thrown and no action is performed. | (4.1) | Default description of listener methods
(addFooListener(), removeFooListener() ). {5} is the operation {add/remove). |
listener.add.descr=Adds the specified {0} listener to receive {0} events from this component. If listener l is null, no exception is thrown and no action is performed. |
| listener.remove.descr | Removes the specified {0} listener so that it no longer receives {0} events from this component. This method performs no function, nor does it throw an exception, if the listener specified by the argument was not previously added to this component. If listener l is null, no exception is thrown and no action is performed. | (4.1) | Default description of listener methods
(addFooListener(), removeFooListener() ). {5} is the operation {add/remove). |
listener.remove.descr=Removes the specified {0} listener so that it no longer receives {0} events from this component. This method performs no function, nor does it throw an exception, if the listener specified by the argument was not previously added to this component. If listener l is null, no exception is thrown and no action is performed. |
| listener.param.descr | Contains the {0}Listener for {0}Event data. | (4.1) | Default description of listener methods
(addFooListener(), removeFooListener() ). {5} is the operation {add/remove). |
listener.param.descr=Contains the {0}Listener for {0}Event data. |
| instance.descr | Gets an instance of this {0} class. | (4.1) | Default description of the static instance() method. | instance.descr=Gets an instance of this {0} class. |
| instance.return.descr | An instance of {0}. | (4.1) | Default description of the static instance() method. | instance.return.descr=An instance of {0}. |
| first.singleline.javadoc | false | (4.3) | first.singleline.javadoc=false | |
| sort.throws | true | (4.3) | sort.throws=true | |
| sort.extends | true | (4.3) | sort.extends=true | |
| sort.implements | true | (4.3) | sort.implements=true | |
| annotation.type.descr | An Anotation | (4.4) | annotation.type.descr=An Anotation | |
| annotation.type.tags | author | (4.4) | annotation.type.tags=author | |
| annotation.method.descr | Annotation part | (4.4) | annotation.method.descr=Annotation part | |
| annotation.method.tags | (4.4) | annotation.method.tags= | ||
| constant.descr | A constant value | (4.4) | constant.descr=A constant value | |
| constant.tags | (4.4) | constant.tags=since |
Last Modified: 7 May 2004