book

THE Java™ Programming Language, Fourth Edition

Name: THE Java™ Programming Language, Fourth Edition
ISBN: 0321349806

by Ken Arnold, James Gosling, David Holmes

August 2005

Intermediate to advanced

928 pages

20h 39m

English

Addison-Wesley Professional

Read now

Unlock full access

Copyright
Dedication
The Java™ Series
Preface
About This BookExamples and DocumentationAcknowledgments (Fourth Edition)Acknowledgments (Third Edition)Acknowledgments (Second Edition)Acknowledgments (First Edition)
1. A Quick Tour
1.1. Getting Started1.2. Variables1.3. Comments in Code1.4. Named Constants1.5. Unicode Characters1.6. Flow of Control1.7. Classes and Objects1.7.1. Creating Objects1.7.2. Static or Class Fields1.7.3. The Garbage Collector1.8. Methods and Parameters1.8.1. Invoking a Method1.8.2. The this Reference1.8.3. Static or Class Methods1.9. Arrays1.10. String Objects1.10.1. String Conversion and Formatting1.11. Extending a Class1.11.1. Invoking Methods of the Superclass1.11.2. The Object Class1.11.3. Type Casting1.12. Interfaces1.13. Generic Types1.14. Exceptions1.15. Annotations1.16. Packages1.17. The Java Platform1.18. Other Topics Briefly Noted
2. Classes and Objects
2.1. A Simple Class2.1.1. Class Members2.1.2. Class Modifiers2.2. Fields2.2.1. Field Initialization2.2.2. Static Fields2.2.3. final Fields2.3. Access Control2.4. Creating Objects2.5. Construction and Initialization2.5.1. Constructors2.5.2. Initialization Blocks2.5.3. Static Initialization2.6. Methods2.6.1. Static Methods2.6.2. Method Invocations2.6.3. Methods with Variable Numbers of Arguments2.6.4. Method Execution and Return2.6.5. Parameter Values2.6.6. Using Methods to Control Access2.7. this2.8. Overloading Methods2.9. Importing Static Member Names2.10. The main Method2.11. Native Methods
3. Extending Classes
3.1. An Extended Class3.2. Constructors in Extended Classes3.2.1. Constructor Order Dependencies3.3. Inheriting and Redefining Members3.3.1. Overriding3.3.2. Hiding Fields3.3.3. Accessing Inherited Members3.3.4. Accessibility and Overriding3.3.5. Hiding Static Members3.3.6. The super Keyword3.4. Type Compatibility and Conversion3.4.1. Compatibility3.4.2. Explicit Type Casting3.4.3. Testing for Type3.5. What protected Really Means3.6. Marking Methods and Classes final3.7. Abstract Classes and Methods3.8. The Object Class3.9. Cloning Objects3.9.1. Strategies for Cloning3.9.2. Correct Cloning3.9.3. Shallow versus Deep Cloning3.10. Extending Classes: How and When3.11. Designing a Class to Be Extended3.11.1. Designing an Extensible Framework3.12. Single Inheritance versus Multiple Inheritance
4. Interfaces
4.1. A Simple Interface Example4.2. Interface Declarations4.2.1. Interface Constants4.2.2. Interface Methods4.2.3. Interface Modifiers4.3. Extending Interfaces4.3.1. Inheriting and Hiding Constants4.3.2. Inheriting, Overriding, and Overloading Methods4.4. Working with Interfaces4.4.1. Implementing Interfaces4.4.2. Using an Implementation4.5. Marker Interfaces4.6. When to Use Interfaces
5. Nested Classes and Interfaces
5.1. Static Nested Types5.1.1. Static Nested Classes5.1.2. Nested Interfaces5.2. Inner Classes5.2.1. Accessing Enclosing Objects5.2.2. Extending Inner Classes5.2.3. Inheritance, Scoping, and Hiding5.3. Local Inner Classes5.3.1. Inner Classes in Static Contexts5.4. Anonymous Inner Classes5.5. Inheriting Nested Types5.6. Nesting in Interfaces5.6.1. Modifiable Variables in Interfaces5.7. Implementation of Nested Types
6. Enumeration Types
6.1. A Simple Enum Example6.2. Enum Declarations6.2.1. Enum Modifiers6.3. Enum Constant Declarations6.3.1. Construction6.3.2. Constant Specific Behavior6.4. java.lang.Enum6.5. To Enum or Not
7. Tokens, Values, and Variables
7.1. Lexical Elements7.1.1. Character Set7.1.2. Comments7.1.3. Tokens7.1.4. Identifiers7.1.5. Keywords7.2. Types and Literals7.2.1. Reference Literals7.2.2. Boolean Literals7.2.3. Character Literals7.2.4. Integer Literals7.2.5. Floating-Point Literals7.2.6. String Literals7.2.7. Class Literals7.3. Variables7.3.1. Field and Local Variable Declarations7.3.2. Parameter Variables7.3.3. final Variables7.4. Array Variables7.4.1. Array Modifiers7.4.2. Arrays of Arrays7.4.3. Array Initialization7.4.4. Arrays and Types7.5. The Meanings of Names

8. Primitives as Types
8.1. Common Fields and Methods8.1.1. Construction8.1.2. Constants8.1.3. Common Methods8.2. Void8.3. Boolean8.4. Number8.4.1. The Integer Wrappers8.4.2. The Floating-Point Wrapper Classes8.5. Character8.5.1. Working with UTF-168.6. Boxing Conversions
9. Operators and Expressions
9.1. Arithmetic Operations9.1.1. Integer Arithmetic9.1.2. Floating-Point Arithmetic9.1.3. Strict and Non-Strict Floating-Point Arithmetic9.2. General Operators9.2.1. Increment and Decrement Operators9.2.2. Relational and Equality Operators9.2.3. Logical Operators9.2.4. instanceof9.2.5. Bit Manipulation Operators9.2.6. The Conditional Operator ?:9.2.7. Assignment Operators9.2.8. String Concatenation Operator9.2.9. new9.3. Expressions9.3.1. Order of Evaluation9.3.2. Expression Type9.4. Type Conversions9.4.1. Implicit Type Conversions9.4.2. Explicit Type Casts9.4.3. String Conversions9.5. Operator Precedence and Associativity9.6. Member Access9.6.1. Finding the Right Method
10. Control Flow
10.1. Statements and Blocks10.2. if–else10.3. switch10.4. while and do–while10.5. for10.5.1. Basic for Statement10.5.2. Enhanced for Statement10.6. Labels10.7. break10.8. continue10.9. return10.10. What, No goto?
11. Generic Types
11.1. Generic Type Declarations11.1.1. Bounded Type Parameters11.1.2. Nested Generic Types11.2. Working with Generic Types11.2.1. Subtyping and Wildcards11.3. Generic Methods and Constructors11.3.1. Generic Invocations and Type Inference11.4. Wildcard Capture11.5. Under the Hood: Erasure and Raw Types11.5.1. Erasure at Runtime11.5.2. Overloading and Overriding11.6. Finding the Right Method — Revisited11.7. Class Extension and Generic Types
12. Exceptions and Assertions
12.1. Creating Exception Types12.2. throw12.2.1. Transfer of Control12.2.2. Asynchronous Exceptions12.3. The throws Clause12.3.1. throws Clauses and Method Overriding12.3.2. throws Clauses and Native Methods12.4. try, catch, and finally12.4.1. finally12.5. Exception Chaining12.6. Stack Traces12.7. When to Use Exceptions12.8. Assertions12.8.1. The assert Statement12.9. When to Use Assertions12.9.1. State Assertions12.9.2. Control Flow Assertions12.10. Turning Assertions On and Off12.10.1. Why Turn Assertions On and Off?12.10.2. Controlling Assertions on the Command Line12.10.3. Complete Removal12.10.4. Making Assertions Required
13. Strings and Regular Expressions
13.1. Character Sequences13.2. The String Class13.2.1. Basic String Operations13.2.2. String Comparisons13.2.3. String Literals, Equivalence and Interning13.2.4. Making Related Strings13.2.5. String Conversions13.2.6. Strings and char Arrays13.2.7. Strings and byte Arrays13.2.8. Character Set Encoding13.3. Regular Expression Matching13.3.1. Regular Expressions13.3.2. Compiling and Matching with Regular Expressions13.3.3. Replacing13.3.4. Regions13.3.5. Efficiency13.4. The StringBuilder Class13.4.1. Modifying the Buffer13.4.2. Getting Data Out13.4.3. Capacity Management13.4.4. The StringBuffer Class13.5. Working with UTF-16
14. Threads
14.1. Creating Threads14.2. Using Runnable14.3. Synchronization14.3.1. synchronized Methods14.3.2. Static synchronized Methods14.3.3. synchronized Statements14.3.4. Synchronization Designs14.4. wait, notifyAll, and notify14.5. Details of Waiting and Notification14.6. Thread Scheduling14.6.1. Voluntary Rescheduling14.7. Deadlocks14.8. Ending Thread Execution14.8.1. Cancelling a Thread14.8.2. Waiting for a Thread to Complete14.9. Ending Application Execution14.10. The Memory Model: Synchronization and volatile14.10.1. Synchronization Actions14.10.2. Final Fields and Security14.10.3. The Happens-Before Relationship14.11. Thread Management, Security, and ThreadGroup14.12. Threads and Exceptions14.12.1. Don't stop14.12.2. Stack Traces14.13. ThreadLocal Variables14.14. Debugging Threads
15. Annotations
15.1. A Simple Annotation Example15.2. Annotation Types15.3. Annotating Elements15.4. Restricting Annotation Applicability15.5. Retention Policies15.6. Working with Annotations
16. Reflection
16.1. The Class Class15.7.1. Type Tokens16.1.2. Class Inspection16.1.3. Examining Class Members16.1.4. Naming Classes16.1.5. Obtaining Class Objects by Name16.1.6. Runtime Type Queries16.2. Annotation Queries16.3. The Modifier Class16.4. The Member classes16.5. Access Checking and AccessibleObject16.6. The Field Class16.6.1. Final Fields16.7. The Method Class16.8. Creating New Objects and the Constructor Class16.8.1. Inner Class Constructors16.9. Generic Type Inspection16.9.1. Type Variables16.9.2. Parameterized Types16.9.3. Wildcards16.9.4. Generic Arrays16.9.5. String Representations of Type Objects16.10. Arrays16.10.1. Genericity and Dynamic Arrays16.11. Packages16.12. The Proxy Class16.13. Loading Classes16.13.1. The ClassLoader Class16.13.2. Preparing a Class for Use16.13.3. Loading Related Resources16.14. Controlling Assertions at Runtime
17. Garbage Collection and Memory
17.1. Garbage Collection17.2. A Simple Model17.3. Finalization17.3.1. Resurrecting Objects during finalize17.4. Interacting with the Garbage Collector17.5. Reachability States and Reference Objects17.5.1. The Reference Class17.5.2. Strengths of Reference and Reachability17.5.3. Reference Queues17.5.4. Finalization and Reachability
18. Packages
18.1. Package Naming18.2. Type Imports18.3. Package Access18.3.1. Accessibility and Overriding Methods18.4. Package Contents18.5. Package Annotations18.6. Package Objects and Specifications
19. Documentation Comments
19.1. The Anatomy of a Doc Comment19.2. Tags19.2.1. @see19.2.2. {@link} and {@linkplain}19.2.3. @param19.2.4. @return19.2.5. @throws and @exception19.2.6. @deprecated19.2.7. @author19.2.8. @version19.2.9. @since19.2.10. {@literal} and {@code}19.2.11. {@value}19.2.12. {@docRoot}19.2.13. {@inheritDoc}19.3. Inheriting Method Documentation Comments19.3.1. Inheriting @throws Comments19.4. A Simple Example19.5. External Conventions19.5.1. Package and Overview Documentation19.5.2. The doc-files Directory19.6. Notes on Usage
20. The I/O Package
20.1. Streams Overview20.2. Byte Streams20.2.1. InputStream20.2.2. OutputStream20.3. Character Streams20.3.1. Reader20.3.2. Writer20.3.3. Character Streams and the Standard Streams20.4. InputStreamReader and OutputStreamWriter20.5. A Quick Tour of the Stream Classes20.5.1. Synchronization and Concurrency20.5.2. Filter Streams20.5.3. Buffered Streams20.5.4. Piped Streams20.5.5. ByteArray Byte Streams20.5.6. CharArray Character Streams20.5.7. String Character Streams20.5.8. Print Streams20.5.9. LineNumberReader20.5.10. SequenceInputStream20.5.11. Pushback Streams20.5.12. StreamTokenizer20.6. The Data Byte Streams20.6.1. DataInput and DataOutput20.6.2. The Data Stream Classes20.7. Working with Files20.7.1. File Streams and FileDescriptor20.7.2. RandomAccessFile20.7.3. The File Class20.7.4. FilenameFilter and FileFilter20.8. Object Serialization20.8.1. The Object Byte Streams20.8.2. Making Your Classes Serializable20.8.3. Serialization and Deserialization Order20.8.4. Customized Serialization20.8.5. Object Versioning20.8.6. Serialized Fields20.8.7. The Externalizable Interface20.8.8. Documentation Comment Tags20.9. The IOException Classes20.10. A Taste of New I/O
21. Collections
21.1. Collections21.1.1. Exception Conventions21.2. Iteration21.3. Ordering with Comparable and Comparator21.4. The Collection Interface21.5. Set and SortedSet21.5.1. HashSet21.5.2. LinkedHashSet21.5.3. TreeSet21.6. List21.6.1. ArrayList21.6.2. LinkedList21.6.3. RandomAccess Lists21.7. Queue21.7.1. PriorityQueue21.8. Map and SortedMap21.8.1. HashMap21.8.2. LinkedHashMap21.8.3. IdentityHashMap21.8.4. WeakHashMap21.8.5. TreeMap21.9. enum Collections21.9.1. EnumSet21.9.2. EnumMap21.10. Wrapped Collections and the Collections Class21.10.1. The Collections Utilities21.10.2. The Unmodifiable Wrappers21.10.3. The Checked Wrappers21.11. Synchronized Wrappers and Concurrent Collections21.11.1. The Synchronized Wrappers21.11.2. The Concurrent Collections21.12. The Arrays Utility Class21.13. Writing Iterator Implementations21.14. Writing Collection Implementations21.15. The Legacy Collection Types21.15.1. Enumeration21.15.2. Vector21.15.3. Stack21.15.4. Dictionary21.15.5. Hashtable21.16. Properties
22. Miscellaneous Utilities
22.1. Formatter22.1.1. Format Specifiers22.1.2. Integer Conversions22.1.3. Floating-Point Conversions22.1.4. Character Conversions22.1.5. General Conversions22.1.6. Custom Formatting22.1.7. Format Exceptions22.1.8. The Formatter Class22.2. BitSet22.3. Observer/Observable22.4. Random22.5. Scanner22.5.1. Stream of Values22.5.2. Scanning Lines22.5.3. Using Scanner22.5.4. Localization22.6. StringTokenizer22.7. Timer and TimerTask22.8. UUID22.9. Math and StrictMath
23. System Programming
23.1. The System Class23.1.1. Standard I/O Streams23.1.2. System Properties23.1.3. Utility Methods23.2. Creating Processes23.2.1. Process23.2.2. Process Environments23.2.3. ProcessBuilder23.2.4. Portability23.3. Shutdown23.3.1. Shutdown Hooks23.3.2. The Shutdown Sequence23.3.3. Shutdown Strategies23.4. The Rest of Runtime23.4.1. Loading Native Code23.4.2. Debugging23.5. Security23.5.1. The SecurityManager Class23.5.2. Permissions23.5.3. Security Policies23.5.4. Access Controllers and Privileged Execution
24. Internationalization and Localization
24.1. Locale24.2. Resource Bundles24.2.1. ListResourceBundle24.2.2. PropertyResourceBundle24.2.3. Subclassing ResourceBundle24.3. Currency24.4. Time, Dates, and Calendars24.4.1. Calendars24.4.2. Time Zones24.4.3. GregorianCalendar and SimpleTimeZone24.5. Formatting and Parsing Dates and Times24.5.1. Using Formatter with Dates and Times24.6. Internationalization and Localization for Text24.6.1. Collation24.6.2. Formatting and Parsing24.6.3. Text Boundaries
25. Standard Packages
25.1. java.awt — The Abstract Window Toolkit25.2. java.applet — Applets25.3. java.beans — Components25.4. java.math — Mathematics25.5. java.net — The Network25.6. java.rmi — Remote Method Invocation25.7. java.security and Related Packages — Security Tools25.8. java.sql — Relational Database Access25.9. Utility Subpackages25.9.1. Concurrency Utilities — java.util.concurrent25.9.2. Archive Files — java.util.jar25.9.3. ZIP Files — java.util.zip25.10. javax.* — Standard Extensions25.11. javax.accessibility — Accessibility for GUIs25.12. javax.naming — Directory and Naming Services25.13. javax.sound — Sound Manipulation25.14. javax.swing — Swing GUI Components25.15. org.omg.CORBA — CORBA APIs
A. Application Evolution
A.1. Language, Library, and Virtual Machine VersionsA.2. Dealing with Multiple DialectsA.3. Generics: Reification, Erasure, and Raw TypesA.3.1. Raw Types, “Unchecked” Warnings, and Bridge MethodsA.3.2. API Issues
B. Useful Tables
Further Reading
Java Platform TopicsObject-Oriented DesignMultithreaded ProgrammingGenericsRegular ExpressionsGeneral Programming TechniquesRelated LanguagesSoftware EngineeringVisual Design & GUI Design
Colophon
Note to Translators
Article
Exercises
Quotes

Content preview from THE Java™ Programming Language, Fourth Edition

Chapter 19. Documentation Comments

	Any member introducing a dog into the Society's premises shall be liable to a fine of £10. Any animal leading a blind person shall be deemed to be a cat.
	--Rule 46, Oxford Union Society (circa 1997)

Documentation comments, usually called doc comments, let you associate reference documentation for programmers directly with your code. The contents of the doc comment can be used to generate reference documentation, typically presented using HTML.

Doc comments are generally designed as fairly terse reference documentation. The reference documentation typically covers the contract of the documented interface, class, constructor, method, or field to the level of detail most programmers need. This approach is distinct ...

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.

Julian F.

Head of Cybersecurity

I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.

Addison B.

Field Engineer

I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.

Amir M.

Data Platform Tech Lead

I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.

Mark W.

Embedded Software Engineer

Publisher Resources

ISBN: 0321349806Purchase book

Cloud Computing

Data Engineering

Data Science

AI & ML

Programming Languages

Software Architecture

IT/Ops

Security

Design

Business

Soft Skills

THE Java™ Programming Language, Fourth Edition

by Ken Arnold, James Gosling, David Holmes

Chapter 19. Documentation Comments

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.