org.cobraparser.html.FormInput Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of Cobra Show documentation
Cobra is the rendering engine designed for LoboBrowser
There is a newer version: 1.0.2
/*
    GNU LESSER GENERAL PUBLIC LICENSE
    Copyright (C) 2006 The Lobo Project

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    Contact info: [email protected]
 */
/*
 * Created on Jan 15, 2006
 */
package org.cobraparser.html;

/**
 * The FormInput class contains the state of an HTML form input
 * item.
 */
public class FormInput {
  // private final InputStream inputStream;
  // private final String charset;
  public static final FormInput[] EMPTY_ARRAY = new FormInput[0];
  private final String name;
  private final String textValue;
  private final java.io.File fileValue;

  /**
   * Constructs a FormInput with a text value.
   *
   * @param name
   *          The name of the input.
   * @param value
   *          The value of the input.
   */
  public FormInput(final String name, final String value) {
    super();
    this.name = name;
    this.textValue = value;
    this.fileValue = null;
  }

  /**
   * Constructs a FormInput with a file value.
   *
   * @param name
   *          The name of the input.
   * @param value
   *          The value of the input.
   */
  public FormInput(final String name, final java.io.File value) {
    this.name = name;
    this.textValue = null;
    this.fileValue = value;
  }

  /**
   * Gets the name of the input.
   */
  public String getName() {
    return this.name;
  }

  /**
   * Returns true if the form input holds a text value.
   */
  public boolean isText() {
    return this.textValue != null;
  }

  /**
   * Returns true if the form input holds a file value.
   */
  public boolean isFile() {
    return this.fileValue != null;
  }

  /**
   * 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 #isText()
   */
  public String getTextValue() {
    return this.textValue;
  }

  /**
   * 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 #isFile()
   */
  public java.io.File getFileValue() {
    return this.fileValue;
  }

  /**
   * Always returns UTF-8.
   *
   * @deprecated The method is implemented only to provide some backward
   *             compatibility.
   */
  @Deprecated
  public String getCharset() {
    return "UTF-8";
  }

  /**
   * Gets data as an input stream. The caller is responsible for closing the
   * stream.
   *
   * @deprecated Call either {@link #getTextValue()} or {@link #getFileValue()}
   *             instead.
   */
  @Deprecated
  public java.io.InputStream getInputStream() throws java.io.IOException {
    if (this.isText()) {
      return new java.io.ByteArrayInputStream(this.getTextValue().getBytes("UTF-8"));
    } else if (this.isFile()) {
      return new java.io.FileInputStream(this.getFileValue());
    } else {
      return null;
    }
  }

  /**
   * Shows a string representation of the FormInput that may be
   * useful in debugging.
   *
   * @see #getTextValue()
   */
  @Override
  public String toString() {
    return "FormInput[name=" + this.name + ",textValue=" + this.textValue + "]";
  }
}