Package com.mcawful.social

Record Class SocialPostResult

java.lang.Object
java.lang.Record
com.mcawful.social.SocialPostResult
Record Components:
success - true if it worked
url - the web address of the new post, or of the profile after linking; null on failure
error - on failure, the reason: NOT_LINKED, EMPTY, TOO_LONG or FAILED
detail - on failure, more information, such as the length of a post that is too long (320/300) or the message from the platform
public record SocialPostResult(boolean success, String url, String error, String detail) extends Record
The result of creating a post or linking an account on a SocialPlatform
Author:
mcawful

  • Field Details

  • Constructor Details

    • SocialPostResult

      public SocialPostResult(boolean success, String url, String error, String detail)
      Creates an instance of a SocialPostResult record class.
      Parameters:
      success - the value for the success record component
      url - the value for the url record component
      error - the value for the error record component
      detail - the value for the detail record component

  • Method Details

    • ok

      public static SocialPostResult ok(String url)
      Creates a successful result
      Parameters:
      url - the web address of the post or profile
      Returns:
      the result

    • failed

      public static SocialPostResult failed(String error, String detail)
      Creates a failed result
      Parameters:
      error - the reason
      detail - more information; may be null
      Returns:
      the result

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • success

      public boolean success()
      Returns the value of the success record component.
      Returns:
      the value of the success record component

    • url

      public String url()
      Returns the value of the url record component.
      Returns:
      the value of the url record component

    • error

      public String error()
      Returns the value of the error record component.
      Returns:
      the value of the error record component

    • detail

      public String detail()
      Returns the value of the detail record component.
      Returns:
      the value of the detail record component