net.openhft.chronicle.core.annotation

Annotation Type RequiredForClient

@Retention(value=SOURCE)
public @interface RequiredForClient

@RequiredForClient warns that the annotated class name is baked into on-wire YAML/JSON or a class-alias pool. Its audience is library maintainers reviewing potential breaking changes.

Retention and effect: Kept in the source only. There is no runtime effect unless build tooling checks for it.

  @RequiredForClient("chronicle-queue-dump tool")
 public class ApiEntry { }
 

Renaming or deleting such classes can break clients and should follow semantic-versioning rules.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	value Specifies an optional comment to provide additional context or information about where this class is referred to.

Element Detail

value

public abstract String value

Specifies an optional comment to provide additional context or information about where this class is referred to.

Returns:

the comment providing more details

Default:

""