Enum OverlayLocation

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<OverlayLocation>

    public enum OverlayLocation
    extends java.lang.Enum<OverlayLocation>
    Use this class to specify the starting location of your overlay. This accounts for video and overlay dimensions and still allows for relative offset.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.Optional<java.lang.String> x  
      private java.util.Optional<java.lang.String> y  
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private OverlayLocation​(java.lang.String x, java.lang.String y)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getExpression​(java.util.Optional<java.lang.Integer> offsetX, java.util.Optional<java.lang.Integer> offsetY)  
      java.lang.String getX​(java.util.Optional<java.lang.Integer> offset)  
      java.lang.String getY​(java.util.Optional<java.lang.Integer> offset)  
      private static java.lang.String resolveExpression​(java.util.Optional<java.lang.String> location, java.util.Optional<java.lang.Integer> offset)  
      static OverlayLocation valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static OverlayLocation[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

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

      • x

        private final java.util.Optional<java.lang.String> x
      • y

        private final java.util.Optional<java.lang.String> y
    • Constructor Detail

      • OverlayLocation

        private OverlayLocation​(java.lang.String x,
                                java.lang.String y)
    • Method Detail

      • values

        public static OverlayLocation[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (OverlayLocation c : OverlayLocation.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static OverlayLocation valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getExpression

        public java.lang.String getExpression​(java.util.Optional<java.lang.Integer> offsetX,
                                              java.util.Optional<java.lang.Integer> offsetY)
      • resolveExpression

        private static java.lang.String resolveExpression​(java.util.Optional<java.lang.String> location,
                                                          java.util.Optional<java.lang.Integer> offset)
      • getX

        public java.lang.String getX​(java.util.Optional<java.lang.Integer> offset)
      • getY

        public java.lang.String getY​(java.util.Optional<java.lang.Integer> offset)