Annotation Interface Export

@Retention(RUNTIME)
public @interface Export

// @formatter:off An annotation to specify the fields that can be used by other scenes.

@Named
@Export("page")
public Scene aMethod() {
  return Scene.begin("page")
              .add(...)
              .end();
}

@Named
@DependsOn("aMethod")
public Scene bMethod() {
  return Scene.begin("object")
              .add("object", func(v -> w), "page")
              .end();
}

The variables in the method with this annotation can be referenced by other method (in this case bMethod) using @DependsOn annotation. The scene in the referencing method can access variables specified in @Export annotation. By default, only Scene.DEFAULT_DEFAULT_VARIABLE_NAME variable in the referenced-side is considered specified. If an @Export is missing, default behavior will be performed. As a result, all variables are exported by default even if you don't use this annotation. Also, note that a variable resolution happens transitively if it is specified in this annotation. That is, even if a variable isn't assigned in a method, as long as it is defined in the upstream dependencies, it will be exposed to downstream.

NOTE: In longer term, this annotation might be renamed because its role is "to limit" variables to be exported in practice, not "to export".

// @formatter:on

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	value	Variable names to be exported from the scene returned by the method this annotation is attached to.

Element Details

value

String[] value

Variable names to be exported from the scene returned by the method this annotation is attached to.

Returns:

Exported variable names.

Default:

{"page"}