The content of this documentation refers to all the Nuxeo products and modules. You may want to check the Nuxeo Platform technical documentation, the Nuxeo Studio documentation, the Core Developer Guide, or the Administration Guide.
Contributors, don't hesitate to move pages in the relevant spaces
Skip to end of metadata
Go to start of metadata

Nuxeo code uses a number of Java annotations. This page lists the Nuxeo-specific annotations and does a recap of the others you may encounter.

Table of contents:

Nuxeo Java Annotations

From the XMap framework, to do easy XML mapping in descriptors:

  • @XObject
  • @XNode
  • @XNodeList
  • @XNodeMap
  • @XContent
  • @XParent

JAX-RS / WebEngine annotations

Standard JAX-RS annotations:

  • @GET
  • @PUT
  • @HEAD
  • @DELETE
  • @POST
  • @PUT
  • @OPTIONS
  • @Path
  • @Consumes
  • @Produces
  • @Context
  • @PathParam
  • @QueryParam

WebEngine Nuxeo extensions:

  • @WebObject
  • @WebAdapter

Seam Annotations

These annotations are described in the Seam annotations documentation.

On Seam components:

  • @Name
  • @Scope
  • @Install
  • @Startup
  • @BypassInterceptors
  • @Synchronized

On fields and methods for bijection:

  • @In
  • @Out
  • @Unwrap
  • @Factory
  • @RequestParameter

For Seam context demarcation:

  • @Begin
  • @End
  • @Create
  • @Destroy
  • @Observer

For Seam remoting:

  • @WebRemote

For use with dataTable:

  • @DataModel
  • @DataModelSelection

Google Guice Annotations

  • @Inject

Unit Test Annotations

These are from JUnit 4:

  • @RunWith
  • @Test
  • @Ignore
  • @Before
  • @After
  • @BeforeClass
  • @AfterClass

Nuxeo defines these for use with @RunWith(FeaturesRunner.class):

  • @Features
  • @Deploy
  • @LocalDeploy
  • @RepositoryConfig

Nuxeo defines these for use with @RunWith(ParameterizedSuite.class) (since 5.6):

  • @SuiteClasses
  • @ParameterizedFeature
  • @Parameters
  • @ParameterizedMethod

Java Language Annotations

From the basic language, you should already know all of these:

  • @Override
  • @Deprecated
  • @SuppressWarnings
  • @Target
  • @Retention
Labels
  • None