Package com.vaadin.flow.component.page

Record Class ScreenOrientationLockError

java.lang.Object
java.lang.Record
com.vaadin.flow.component.page.ScreenOrientationLockError
Record Components:
name - the DOMException name, e.g. "SecurityError"
message - the DOMException message, suitable for logging
All Implemented Interfaces:
Serializable
public record ScreenOrientationLockError(String name, String message) extends Record implements Serializable
Describes a failed screen-orientation lock request.

Fields mirror the DOMException the browser rejects screen.orientation.lock() with. The most common values for name are:

  • "NotSupportedError" — the browser does not implement the Screen Orientation API at all, or does not allow locking on this device.
  • "SecurityError" — the document is not in fullscreen, which most browsers require for locking.
  • "AbortError" — a newer lock or unlock call superseded this one.
See Also:

  • Constructor Details

    • ScreenOrientationLockError

      public ScreenOrientationLockError(String name, String message)
      Creates an instance of a ScreenOrientationLockError record class.
      Parameters:
      name - the value for the name record component
      message - the value for the message record component

  • Method Details

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • name

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

    • message

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