Class InsufficientPlan


  • public class InsufficientPlan
    extends java.lang.Object
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String message  
      protected java.lang.String upsellUrl  
    • Constructor Summary

      Constructors 
      Constructor Description
      InsufficientPlan​(java.lang.String message)
      None
      InsufficientPlan​(java.lang.String message, java.lang.String upsellUrl)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getMessage()
      A message to tell the user to upgrade in order to support expected action.
      java.lang.String getUpsellUrl()
      A URL to send the user to in order to obtain the account type they need, e.g.
      int hashCode()  
      java.lang.String toString()  
      java.lang.String toStringMultiline()
      Returns a String representation of this object formatted for easier readability.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • message

        @Nonnull
        protected final java.lang.String message
      • upsellUrl

        @Nullable
        protected final java.lang.String upsellUrl
    • Constructor Detail

      • InsufficientPlan

        public InsufficientPlan​(@Nonnull
                                java.lang.String message,
                                @Nullable
                                java.lang.String upsellUrl)
        Parameters:
        message - A message to tell the user to upgrade in order to support expected action. Must not be null.
        upsellUrl - A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
      • InsufficientPlan

        public InsufficientPlan​(@Nonnull
                                java.lang.String message)
        None

        The default values for unset fields will be used.

        Parameters:
        message - A message to tell the user to upgrade in order to support expected action. Must not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
    • Method Detail

      • getMessage

        @Nonnull
        public java.lang.String getMessage()
        A message to tell the user to upgrade in order to support expected action.
        Returns:
        value for this field, never null.
      • getUpsellUrl

        @Nullable
        public java.lang.String getUpsellUrl()
        A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade.
        Returns:
        value for this field, or null if not present.
      • 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
      • toStringMultiline

        public java.lang.String toStringMultiline()
        Returns a String representation of this object formatted for easier readability.

        The returned String may contain newlines.

        Returns:
        Formatted, multiline String representation of this object