Package com.fluxtion.builder.generation

Class FilterDescription

java.lang.Object
com.fluxtion.builder.generation.FilterDescription
public class FilterDescription
extends java.lang.Object
Customises the generated source files to provide user controlled FilterDescription's. A user can provide logic to control comment and variable names for filters in the generated code. The intention is to make the generated SEP easier to understand reducing cost to rectify errors.

FilterDescriptionProducer are registered as producers of descriptions.

Author:
Greg Higgins

  • Field Summary

    Fields 
    Modifier and Type Field Description
    java.lang.String comment
    Human readable comment to be associated with this filter in the generated code of the SEP.
    static FilterDescription DEFAULT_FILTER  
    java.lang.Class<? extends com.fluxtion.api.event.Event> eventClass
    the event class for this filter.
    static FilterDescription INVERSE_FILTER  
    boolean isFiltered
    Indicates presence of filtering, false value means match all values.
    boolean isIntFilter
    boolean value indicating String or integer based filtering.
    static FilterDescription NO_FILTER  
    java.lang.String stringValue
    Value used by the SEP to determine which decision branch to navigate.
    int value
    Value used by the SEP to determine which decision branch to navigate.
    java.lang.String variableName
    User suggested identifier for this filter in the generated SEP code.

  • Constructor Summary

    Constructors 
    Constructor Description
    FilterDescription​(java.lang.Class<? extends com.fluxtion.api.event.Event> eventClass)  
    FilterDescription​(java.lang.Class<? extends com.fluxtion.api.event.Event> eventClass, int value)  
    FilterDescription​(java.lang.Class<? extends com.fluxtion.api.event.Event> eventClass, java.lang.String value)  

  • Method Summary

    Modifier and Type Method Description
    FilterDescription changeClass​(java.lang.Class<? extends com.fluxtion.api.event.Event> newClass)  
    boolean equals​(java.lang.Object obj)  
    int hashCode()  
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • NO_FILTER

      public static final FilterDescription NO_FILTER

    • INVERSE_FILTER

      public static final FilterDescription INVERSE_FILTER

    • DEFAULT_FILTER

      public static final FilterDescription DEFAULT_FILTER

    • value

      public final int value
      Value used by the SEP to determine which decision branch to navigate. If integer filtering is used.

    • stringValue

      public final java.lang.String stringValue
      Value used by the SEP to determine which decision branch to navigate. If String filtering is used

    • isIntFilter

      public final boolean isIntFilter
      boolean value indicating String or integer based filtering.

    • isFiltered

      public boolean isFiltered
      Indicates presence of filtering, false value means match all values.

    • eventClass

      public java.lang.Class<? extends com.fluxtion.api.event.Event> eventClass
      the event class for this filter.

    • comment

      public java.lang.String comment
      Human readable comment to be associated with this filter in the generated code of the SEP. Depending upon the target language this value may be mutated to suit the target language rules.

    • variableName

      public java.lang.String variableName
      User suggested identifier for this filter in the generated SEP code. Depending upon the target language this value may be mutated to suit the relevant rules.

  • Constructor Details

    • FilterDescription

      public FilterDescription​(java.lang.Class<? extends com.fluxtion.api.event.Event> eventClass)

    • FilterDescription

      public FilterDescription​(java.lang.Class<? extends com.fluxtion.api.event.Event> eventClass, int value)

    • FilterDescription

      public FilterDescription​(java.lang.Class<? extends com.fluxtion.api.event.Event> eventClass, java.lang.String value)

  • Method Details

    • changeClass

      public FilterDescription changeClass​(java.lang.Class<? extends com.fluxtion.api.event.Event> newClass)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • equals

      public boolean equals​(java.lang.Object obj)
      Overrides:
      equals in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object