org.jboss.logging.annotations

public @Interface ValidIdRange

Annotations

@Target:TYPE
@Retention:CLASS
@Documented

Static Imports

java.lang.annotation.ElementType.TYPE, .RetentionPolicy.CLASS

Sets a range of valid id's allowed on the message id. Both Message#INHERIT and Message#NONE are ignored when validating.

Note

Message id's from inherited interfaces are not validated within the range provided. Super interfaces would need their own annotation for range validation.

         @MessageLogger(projectCode = "EXAMPLE")
         @ValidIdRange(min = 100, max = 200)
         public interface ExampleLogger {

             @LogMessage
             @Message(id = 100, value = "Example message")
             void example();
         }

Author: James R. Perkins

Method Summary

Modifier and Type	Method and Description
public int	Returns: the maximum id allowed max() The maximum id allowed in the `message id`.
public int	Returns: the minimum id allowed min() The minimum id allowed in the `message id`.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

max back to summary

max	back to summary
public int max() The maximum id allowed in the `message id`. Both `Message#INHERIT` and `Message#NONE` are ignored when validating. Returns:int the maximum id allowed

public int max()

The maximum id allowed in the message id. Both Message#INHERIT and Message#NONE are ignored when validating.

Returns:int: the maximum id allowed

min back to summary

min	back to summary
public int min() The minimum id allowed in the `message id`. Both `Message#INHERIT` and `Message#NONE` are ignored when validating. Returns:int the minimum id allowed

public int min()

The minimum id allowed in the message id. Both Message#INHERIT and Message#NONE are ignored when validating.

Returns:int: the minimum id allowed