Eclipse Templates
Eclipse comes with a bunch of code templates that can save you a lot
of typing. Most notably the templates sysout (expands to
System.out.println()) and for / foreach to easily iterate over a
collection or an array.
It is also easy to add custom templates. This repository contains some of the templates I created and which might be useful for others too.
Java Templates
Category: Logging
Create SLF4J Logger
Name: logger
Description: Creates an SLF4J logger instance with the name of the enclosing class.
Example:
This code
public class Foo {
logger<CTRL-SPC>
}expands to
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class Foo {
private static final Logger LOG = LoggerFactory.getLogger(Foo.class);
}Log message
Name: log
Description: Creates a log statement. Lets you select the level from a list of choices.
Example:
This code
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class Foo {
private static final Logger LOG = LoggerFactory.getLogger(Foo.class);
public void bar() {
log<CTRL-SPC>
}
}expands to
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class Foo {
private static final Logger LOG = LoggerFactory.getLogger(Foo.class);
public void bar() {
LOG.debug("");
}
}Log debug message
Name: logd
Description: Same as log but with fixed DEBUG level.
Log info message
Name: logi
Description: Same as log but with fixed INFO level.
Log warning message
Name: logw
Description: Same as log but with fixed WARN level.
Log error message
Name: loge
Description: Same as log but with fixed ERROR level.
Category: JUnit Tests
Test method
Name: test
Description: Creates a JUnit test method body annotated with @Test
and prompts you for the test method name.
This templates is an enhancement of the standard template Test
shipped with Eclipse. Additional to the standard template, the
following static imports are added:
org.junit.Assert.*org.hamcrest.Matchers.*org.easymock.EasyMock.*
Example:
This code
public class FooTest {
}expands to
import static org.junit.Assert.*;
import static org.hamcrest.Matchers.*;
import static org.easymock.Easymock.*;
public class FooTest {
@Test
public void testX() throws Exception {
}
}Test Assertion
Name: assert
Description: Creates a JUnit assertion body. Adds useful static imports.
Example:
This code
public class FooTest {
@Test
public void testBar() throws Exception {
assert<CTRL-SPC>
}
}expands to
import static org.junit.Assert.assertThat;
import static org.hamcrest.Matchers.*;
public class FooTest {
@Test
public void testBar() throws Exception {
assertThat( , Matchers. );
}
}Test Setup
Name: before
Description: Creates a test setup method body.
Example:
This code
public class FooTest {
before<CTRL-SPC>
}expands to
import org.junit.Before;
public class FooTest {
@Before
public void setUp() throws Exception {
}
}Test Teardown
Name: after
Description: Creates a test teardown method body.
Example:
This code
public class FooTest {
after<CTRL-SPC>
}expands to
import org.junit.After;
public class FooTest {
@After
public void tearDown() throws Exception {
}
}Test Setup Before Class
Name: beforeclass
Description: Creates a test setup-before-class method body.
Example:
This code
public class FooTest {
beforeclass<CTRL-SPC>
}expands to
import org.junit.BeforeClass;
public class FooTest {
@BeforeClass
public void setUpBeforeClass() throws Exception {
}
}Test Teardown After Class
Name: afterclass
Description: Creates a test teardown-after-class method body.
Example:
This code
public class FooTest {
afterclass<CTRL-SPC>
}expands to
import org.junit.AfterClass;
public class FooTest {
@AfterClass
public void tearDownAfterClass() throws Exception {
}
}Category: Misc
Iterate over Map
Name: formap
Description: Iterates over the entries of a java.util.Map with a
foreach loop.
Example:
This code
Map<String, String> myMap = new HashMap<String, String>();
formap<CTRL-SPC>>expands to
Map<String, String> myMap = new HashMap<String, String>();
for (Map.Entry< , > entry : myMap.entrySet()) {
}Check for null
Name: ifnull
Description: Creates a block to execute when a local variable is null.
Example:
This code
Integer i = null;
ifnull<CTRL-SPC>>expands to
Integer i = null;
if (i == null) {
}Check for not-null
Name: ifnotnull
Description: Creates a block to execute when a local variable is not null.
Example:
This code
Integer i = null;
ifnotnull<CTRL-SPC>>expands to
Integer i = null;
if (i != null) {
}Equals- / HashCode- / ToStringBuilder
Name: builder
Description: Creates equals(), hashCode() and toString() methods
which make use of the builder classes from commons-lang. When
typing field names (up to 3), those are inserted accordingly in each
of the 3 methods.
Example:
This code
public class Foo {
builder<CTRL-SPC>
}expands to
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;
import org.apache.commons.lang3.builder.ToStringBuilder;
public class Foo {
@Override
public boolean equals(Object obj) {
if (obj == null) { return false; }
if (obj == this) { return true; }
if (obj.getClass() != getClass()) { return false; }
Foo rhs = (Foo) obj;
return new EqualsBuilder()
.appendSuper(super.equals(obj))
.append(this.field1, rhs.field1)
.append(this.field2, rhs.field2)
.append(this.field3, rhs.field3)
.isEquals();
}
@Override
public int hashCode() {
return new HashCodeBuilder(17, 37)
.append(field1)
.append(field2)
.append(field3)
.toHashCode();
}
@Override
public String toString() {
return new ToStringBuilder(this, ToStringStyle.DEFAULT_STYLE)
.append("field1", field1)
.append("field2", field2)
.append("field3", field3)
.toString();
}
}Equals- / HashCode- / ToStringBuilder with Reflection
Name: builder equals hashcode reflection
Description: Creates equals(), hashCode() and toString() methods
which make use of the builder classes from commons-lang using
their reflection-based methods.
Example:
This code
public class Foo {
builder<CTRL-SPC>
}expands to
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;
import org.apache.commons.lang3.builder.ToStringBuilder;
public class Foo {
@Override
public boolean equals(Object obj) {
return EqualsBuilder.reflectionEquals(this, obj);
}
@Override
public int hashCode() {
return HashCodeBuilder.reflectionHashCode(17, 37, this);
}
@Override
public String toString() {
return ToStringBuilder.reflectionToString(this, ToStringStyle.DEFAULT_STYLE);
}
}