/**
 * Licensed 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.
 *
 * Copyright 2012-2015 the original author or authors.
 */
package org.assertj.swing.launcher;

import javax.annotation.Nonnull;

/**
 * <p>
 * Fluent interface for creation of {@code Applet} parameters.
 * </p>
 *
 * <p>
 * For example, the following code listing:
 * </p>
 *
 * <pre>
 * // import static org.assertj.swing.launcher.AppletParameter.name;
 *
 * AppletParameter p = {@link #name(String) name}("bgcolor").{@link AppletParameterBuilder#value(String) value}("blue");
 * </pre>
 *
 * <p>
 * will create an applet parameter with name "bgcolor" and value "blue."
 * </p>
 *
 * @author Yvonne Wang
 */
public class AppletParameter {
  public final String name;
  public final String value;

  AppletParameter(@Nonnull String name, @Nonnull String value) {
    this.name = name;
    this.value = value;
  }

  /**
   * Starting point of the fluent interface for creation of {@link AppletParameter}s.
   *
   * @param name the name of the {@code Applet} parameter.
   * @return a builder of {@code AppletParameter}s.
   */
  public static @Nonnull AppletParameterBuilder name(String name) {
    return new AppletParameterBuilder(name);
  }

  /**
   * Builder for instances of {@link AppletParameter}.
   *
   * @author Yvonne Wang
   */
  public static class AppletParameterBuilder {
    private final String name;

    AppletParameterBuilder(@Nonnull String name) {
      this.name = name;
    }

    /**
     * Creates a new {@link AppletParameter} with the given name and value.
     *
     * @param value the value for the {@code AppletParameter}.
     * @return the created {@code AppletParameter}.
     */
    public AppletParameter value(@Nonnull String value) {
      return new AppletParameter(name, value);
    }
  }
}