net.sf.eBus.messages

Annotation Type ELocalOnly

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Documented
public @interface ELocalOnly

This class-level annotation is used to mark an EMessage or EField class as local-only meaning that the message may only be used within the JVM and will not be transmitted to remote eBus applications. Marking a message as @ELocalOnly prevents eBus from generating the serialization/de-serialization code necessary for message transmission. This means that a local-only message may contain unsupported field types like Map.

This annotation should be used when messages are designed for internal use only and should not be transmitted outside the JVM. net.sf.eBusx.io, net.sf.eBusx.util, and net.sf.eBus.feed packages use this feature for their JVM-only messages.

Note that a message is assumed to transmittable unless annotated as ELocalOnly.

It is an error to open an eBus feed for a ELocalOnly message but with EFeed.FeedScope other than FeedScope.LOCAL_ONLY.

It is an error to define an eBus message or field as transmittable (not local-only) but contains a local-only EMessageObject field.

Author:

Charles W. Rapp