Class FormInput


  • public class FormInput
    extends java.lang.Object
    The FormInput class contains the state of an HTML form input item.
    • Constructor Summary

      Constructors 
      Constructor Description
      FormInput​(java.lang.String name, java.io.File value)
      Constructs a FormInput with a file value.
      FormInput​(java.lang.String name, java.lang.String value)
      Constructs a FormInput with a text value.
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String getCharset()
      Deprecated.
      The method is implemented only to provide some backward compatibility.
      java.io.File getFileValue()
      Gets the file value of the form input.
      java.io.InputStream getInputStream()
      Deprecated.
      Call either getTextValue() or getFileValue() instead.
      java.lang.String getName()
      Gets the name of the input.
      java.lang.String getTextValue()
      Gets the text value of the form input.
      boolean isFile()
      Returns true if the form input holds a file value.
      boolean isText()
      Returns true if the form input holds a text value.
      java.lang.String toString()
      Shows a string representation of the FormInput that may be useful in debugging.
      • Methods inherited from class java.lang.Object

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

      • EMPTY_ARRAY

        public static final FormInput[] EMPTY_ARRAY
    • Constructor Detail

      • FormInput

        public FormInput​(java.lang.String name,
                         java.lang.String value)
        Constructs a FormInput with a text value.
        Parameters:
        name - The name of the input.
        value - The value of the input.
      • FormInput

        public FormInput​(java.lang.String name,
                         java.io.File value)
        Constructs a FormInput with a file value.
        Parameters:
        name - The name of the input.
        value - The value of the input.
    • Method Detail

      • getName

        public java.lang.String getName()
        Gets the name of the input.
      • isText

        public boolean isText()
        Returns true if the form input holds a text value.
      • isFile

        public boolean isFile()
        Returns true if the form input holds a file value.
      • getTextValue

        public java.lang.String getTextValue()
        Gets the text value of the form input. If the form input does not hold a text value, this method should not be called.
        See Also:
        isText()
      • getFileValue

        public java.io.File getFileValue()
        Gets the file value of the form input. If the form input does not hold a file value, this method should not be called.
        See Also:
        isFile()
      • getCharset

        public java.lang.String getCharset()
        Deprecated.
        The method is implemented only to provide some backward compatibility.
        Always returns UTF-8.
      • getInputStream

        public java.io.InputStream getInputStream()
                                           throws java.io.IOException
        Deprecated.
        Call either getTextValue() or getFileValue() instead.
        Gets data as an input stream. The caller is responsible for closing the stream.
        Throws:
        java.io.IOException
      • toString

        public java.lang.String toString()
        Shows a string representation of the FormInput that may be useful in debugging.
        Overrides:
        toString in class java.lang.Object
        See Also:
        getTextValue()