Package org.faktorips.runtime

Class CardinalityRange

  • All Implemented Interfaces:
    java.io.Serializable, org.faktorips.valueset.Range<java.lang.Integer>, org.faktorips.valueset.ValueSet<java.lang.Integer>
    public class CardinalityRange
extends org.faktorips.valueset.IntegerRange
    A Range class for cardinalities. A CardinalityRange is defined by a lower and an upper bound as well as a default value.
    Author:
    Stefan Widmaier
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static CardinalityRange FULL_RANGE
      A cardinality that describes the full range from 0 to * with default 0.
      static CardinalityRange MANDATORY
      A cardinality that describes the obligatory range 1 to 1 with default 1.
      static CardinalityRange OPTIONAL
      A cardinality that describes the optional range from 0 to 1 with default 0.

    • Constructor Summary

      Constructors 
      Constructor Description
      CardinalityRange​(java.lang.Integer lower, java.lang.Integer upper, java.lang.Integer def)
      Constructs a CardinalityRange with the given lower and upper bounds as well as the given default value.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.Integer getDefaultCardinality()  
      int hashCode()  
      java.lang.String toString()  

      • Methods inherited from class org.faktorips.valueset.IntegerRange

        checkIfValueCompliesToStepIncrement, getNextValue, getNullValue, sizeForDiscreteValuesExcludingNull, valueOf, valueOf, valueOf, valueOf, valueOf

      • Methods inherited from class org.faktorips.valueset.DefaultRange

        checkIfStepFitsIntoBounds, contains, containsNull, getLowerBound, getStep, getUpperBound, getValues, isDiscrete, isEmpty, isRange, size

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • OPTIONAL

        public static final CardinalityRange OPTIONAL
        A cardinality that describes the optional range from 0 to 1 with default 0.

      • MANDATORY

        public static final CardinalityRange MANDATORY
        A cardinality that describes the obligatory range 1 to 1 with default 1.

      • FULL_RANGE

        public static final CardinalityRange FULL_RANGE
        A cardinality that describes the full range from 0 to * with default 0.

    • Constructor Detail

      • CardinalityRange

        public CardinalityRange​(java.lang.Integer lower,
                        java.lang.Integer upper,
                        java.lang.Integer def)
        Constructs a CardinalityRange with the given lower and upper bounds as well as the given default value. The default value must be in between the lower and upper bound or equal to one of them (though not Integer.MAX_VALUE).
        Parameters:
        lower - the lowest possible cardinality
        upper - the highest possible cardinality
        def - the default cardinality, must be in between or equal to one of the bounds
        Throws:
        java.lang.IllegalArgumentException - if the default value is not in the range.

    • Method Detail

      • getDefaultCardinality

        public java.lang.Integer getDefaultCardinality()

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class org.faktorips.valueset.DefaultRange<java.lang.Integer>

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class org.faktorips.valueset.DefaultRange<java.lang.Integer>

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class org.faktorips.valueset.DefaultRange<java.lang.Integer>