Class URLConnectionOptions


  • public final class URLConnectionOptions
    extends java.lang.Object
    Carries options and operates on URLConnection.
    Since:
    2.8.0
    • Field Detail

      • allowUserInteraction

        private boolean allowUserInteraction
        TODO
      • connectTimeoutMillis

        private int connectTimeoutMillis
        TODO
      • readTimeoutMillis

        private int readTimeoutMillis
        TODO
      • useCaches

        private boolean useCaches
        TODO
    • Constructor Detail

      • URLConnectionOptions

        public URLConnectionOptions()
        Constructs a new default instance.
      • URLConnectionOptions

        public URLConnectionOptions​(URLConnectionOptions urlConnectionOptions)
        Constructs an instance with values from the given URLConnectionOptions.
        Parameters:
        urlConnectionOptions - the source
    • Method Detail

      • apply

        public java.net.URLConnection apply​(java.net.URLConnection urlConnection)
        Applies the options to the given connection.
        Parameters:
        urlConnection - the target connection.
        Returns:
        the given connection.
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • getAllowUserInteraction

        public boolean getAllowUserInteraction()
        Gets whether to allow user interaction.
        Returns:
        whether to allow user interaction.
      • getConnectTimeoutMillis

        public int getConnectTimeoutMillis()
        Gets the connect timeout.
        Returns:
        the connect timeout.
      • getReadTimeoutMillis

        public int getReadTimeoutMillis()
        Gets the read timeout.
        Returns:
        the read timeout.
      • getUseCaches

        public boolean getUseCaches()
        Whether to cache.
        Returns:
        Whether to cache.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • openConnection

        public java.net.URLConnection openConnection​(java.net.URL url)
                                              throws java.io.IOException
        Opens a connection for the given URL with our options.
        Parameters:
        url - the URL to open
        Returns:
        A new connection
        Throws:
        java.io.IOException - if an I/O exception occurs.
      • setAllowUserInteraction

        public URLConnectionOptions setAllowUserInteraction​(boolean allowUserInteraction)
      • setConnectTimeoutMillis

        public URLConnectionOptions setConnectTimeoutMillis​(int connectTimeoutMillis)
      • setReadTimeoutMillis

        public URLConnectionOptions setReadTimeoutMillis​(int readTimeoutMillis)
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object