Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A utility class which aids in generating Java source files.
branch: master

This branch is 410 commits behind square:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
src
.gitignore
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE.txt
README.md
checkstyle.xml
pom.xml

README.md

Java Writer

JavaWriter is a utility class which aids in generating Java source files.

Source file generation can useful when doing things such as annotation processing or interacting with metadata files (e.g., database schemas, protocol formats). By generating code, you eliminate the need to write boilerplate while also keeping a single source of truth for the metadata.

Example

writer.emitPackage("com.example")
    .beginType("com.example.Person", "class", PUBLIC | FINAL)
    .emitField("String", "firstName", PRIVATE)
    .emitField("String", "lastName", PRIVATE)
    .emitJavadoc("Returns the person's full name.")
    .beginMethod("String", "getName", PUBLIC)
    .emitStatement("return firstName + \" \" + lastName;")
    .endMethod()
    .endType();

Would produce the following source output:

package com.example;

public final class Person {
  private String firstName;
  private String lastName;
  /**
   * Returns the person's full name.
   */
  public String getName() {
    return firstName + " " + lastName;;
  }
}

Download

Download the latest .jar or depend via Maven:

<dependency>
  <groupId>com.squareup</groupId>
  <artifactId>javawriter</artifactId>
  <version>(insert latest version)</version>
</dependency>

License

Copyright 2013 Square, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Something went wrong with that request. Please try again.