org.apache.guacamole.form.TextField Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of guacamole-ext Show documentation

The Java API for extending the main Guacamole web application. This is not needed for authoring a new Guacamole-based web application.

There is a newer version: 1.5.5

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.guacamole.form;

import java.util.Collection;

/**
 * Represents a basic text field. The field may generally contain any data, but
 * may not contain multiple lines.
 */
public class TextField extends Field {

    /**
     * Creates a new TextField with the given name.
     *
     * @param name
     *     The unique name to associate with this field.
     */
    public TextField(String name) {
        super(name, Field.Type.TEXT);
    }

    /**
     * Creates a new TextField with the given name and possible values. As a
     * text field may contain any data by definition, any provided options are
     * simply known-good values.
     *
     * @param name
     *     The unique name to associate with this field.
     *
     * @param options
     *     A set of known legal options for this field.
     */
    public TextField(String name, Collection options) {
        super(name, Field.Type.TEXT, options);
    }

    /**
     * Parses the given string, interpreting empty strings as equivalent to
     * null. For all other cases, the given string is returned verbatim.
     *
     * @param str
     *     The string to parse, which may be null.
     *
     * @return
     *     The given string, or null if the given string was null or empty.
     */
    public static String parse(String str) {

        // Return null if no value provided
        if (str == null || str.isEmpty())
            return null;

        // Otherwise, return string unmodified
        return str;

    }

}