Package jakarta.faces.view.facelets

Class MetaRuleset

  • public abstract class MetaRuleset
extends java.lang.Object

    A mutable set of rules to be used in auto-wiring state to a particular object instance. Rules assigned to this object will be composed into a single Metadata instance which will encapsulate the ruleset.

    Since:
    2.0

    • Constructor Summary

      Constructors 
      Constructor Description
      MetaRuleset()  

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract MetaRuleset add​(Metadata metadata)
      Add another Metadata to this ruleset, returning this.
      abstract MetaRuleset addRule​(MetaRule rule)
      Add another MetaRule to this ruleset, returning this.
      abstract MetaRuleset alias​(java.lang.String attribute, java.lang.String property)
      Customize this MetaRuleset by removing the attribute named by argument attribute and re-adding it under the name given by the argument property, returning this.
      abstract Metadata finish()
      Take actions to apply the rule.
      abstract MetaRuleset ignore​(java.lang.String attribute)
      Customize this MetaRuleset instance to advise it to ignore the attribute named by the attribute argument, returning this.
      abstract MetaRuleset ignoreAll()
      Customize this MetaRuleset instance to advise it to ignore all attributes, returning this.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • MetaRuleset

        public MetaRuleset()

    • Method Detail

      • ignore

        public abstract MetaRuleset ignore​(java.lang.String attribute)

        Customize this MetaRuleset instance to advise it to ignore the attribute named by the attribute argument, returning this.

        Parameters:
        attribute - the name of the attribute to ignore.
        Returns:
        the MetaRuleset with the given attribute ignored.
        Since:
        2.0

      • ignoreAll

        public abstract MetaRuleset ignoreAll()

        Customize this MetaRuleset instance to advise it to ignore all attributes, returning this.

        Returns:
        the ignoreAll MetaRuleset.
        Since:
        2.0

      • alias

        public abstract MetaRuleset alias​(java.lang.String attribute,
                                  java.lang.String property)

        Customize this MetaRuleset by removing the attribute named by argument attribute and re-adding it under the name given by the argument property, returning this.

        Parameters:
        attribute - the attribute to remove.
        property - the property to add.
        Returns:
        the aliased MetaRuleSet.
        Since:
        2.0

      • finish

        public abstract Metadata finish()

        Take actions to apply the rule.

        Returns:
        the Metadata with the MetaRuleSet applied.