Java Snippets for VS Code

⚠️ Disclaimer ⚠️

This is not the official Visual Studio Code extension. This is a community-created extension with a comprehensive collection of Java code snippets for Visual Studio Code, designed to boost your productivity when writing Java code.

Features

This extension provides snippets for:

Basic Java Constructs

• Class definitions (regular, abstract, with constructor)
• Interface definitions
• Method definitions (public, private, static)
• Constructor definitions
• Main method
• Package and import statements

Object-Oriented Programming

• Inheritance (extends)
• Interface implementation
• Abstract classes
• Enums with descriptions
• Records (Java 16+)
• Sealed classes (Java 17+)

Control Structures

• If statements (if, if-else, if-else-if)
• Switch statements and expressions (Java 14+)
• For loops (standard and enhanced)
• While and do-while loops
• Pattern matching (Java 17+)

Exception Handling

• Try-catch blocks
• Try-catch-finally blocks
• Try-with-resources
• Custom exceptions
• Throw statements

Collections and Data Structures

• ArrayList
• HashMap
• HashSet
• Arrays
• Stream operations
• Optional handling

Modern Java Features

• Lambda expressions
• Stream API operations
• Optional handling
• Text blocks (Java 15+)
• Pattern matching
• Records
• Sealed classes

Design Patterns

• Builder pattern
• Singleton pattern
• Factory pattern

Testing

• JUnit test methods
• Before/After hooks
• Assertions

Spring Framework

• REST Controllers
• Services
• Repositories

Logging and I/O

• Logger declarations
• Log messages (info, error)
• Console output
• File operations

Documentation

• JavaDoc for classes
• JavaDoc for methods
• Annotations

Concurrency

• Thread creation
• Runnable tasks
• CompletableFuture
• Synchronized blocks

Usage

Type the prefix of the snippet and press Tab or Enter to insert it. The following prefixes are available:

Basic Constructs

• class - Create a new class
• classc - Create a class with constructor
• abstract - Create an abstract class
• interface - Create a new interface
• extends - Class that extends another class
• implements - Class that implements an interface
• main - Create main method
• method - Create a method
• pmethod - Create a private method
• smethod - Create a static method
• constructor - Create a constructor
• getter - Create a getter method
• setter - Create a setter method
• getset - Create getter and setter methods

Variables and Fields

• var - Declare a variable
• final - Declare a final variable
• field - Declare an instance variable

Control Flow

• if - Create an if statement
• ife - Create an if-else statement
• ifelseif - Create an if-else if statement
• switch - Create a switch statement
• switche - Create a switch expression (Java 14+)
• for - Create a for loop
• fore - Create an enhanced for loop
• while - Create a while loop
• dowhile - Create a do-while loop

Exception Handling

• try - Create a try-catch block
• tryf - Create a try-catch-finally block
• tryr - Create a try-with-resources block
• exception - Create a custom exception class
• throw - Throw an exception

Collections

• arraylist - Create an ArrayList
• hashmap - Create a HashMap
• hashset - Create a HashSet
• array - Create an array

Modern Java

• lambda - Create a lambda expression
• stream - Create a stream operation chain
• streamfilter - Create a stream filter operation
• streammap - Create a stream map operation
• streamforeach - Create a stream forEach operation
• optional - Create an Optional
• optionalh - Create Optional handling chain
• record - Create a record (Java 16+)
• sealed - Create a sealed class (Java 17+)
• instanceof - Pattern matching with instanceof (Java 17+)
• textblock - Create a text block (Java 15+)

Design Patterns

• builder - Create a builder pattern
• singleton - Create a singleton pattern

Testing

• test - Create a JUnit test method
• beforeeach - Create a JUnit @BeforeEach method
• aftereach - Create a JUnit @AfterEach method
• assertEquals - JUnit assertEquals
• assertTrue - JUnit assertTrue
• assertThrows - JUnit assertThrows

Spring

• controller - Create a Spring REST controller
• service - Create a Spring service
• repository - Create a Spring repository

Logging and I/O

• logger - Add logger declaration
• loginfo - Log info message
• logerror - Log error message
• sout - Print to console
• soutf - Print formatted string

Concurrency

• thread - Create and start a thread
• runnable - Create a runnable
• completablefuture - Create a CompletableFuture
• synchronized - Create a synchronized block

Documentation

• docclass - Add class JavaDoc
• docmethod - Add method JavaDoc
• annotation - Add an annotation
• override - Override a method
• deprecated - Mark as deprecated

Package Management

• package - Add package declaration
• import - Add import statement
• importstatic - Add static import

Requirements

• Visual Studio Code 1.60.0 or higher
• Java Development Kit (JDK) 8 or higher

Extension Settings

This extension contributes the following settings:

• java.snippets.enable: Enable/disable Java snippets
• java.snippets.prefix: Customize snippet prefixes

Known Issues

None at the moment.

Contributing

We welcome your feedback and suggestions to improve these snippets.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Thanks to the VS Code team for their extensible editor & excellent extension API
• Thanks to all contributors who have helped improve this extension

Support

If you find this extension helpful, please consider:

• Sharing the extension
• Starring the repository
• Reporting bugs
• Suggesting new features
• Giving appropriate rating of extension on marketplace