io.termd.core.readline.Function Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of termd-core Show documentation

An open source terminal daemon library providing terminal handling in Java, back ported to Alibaba by core engine team to support running on JDK 6+.

The newest version!

/*
 * Copyright 2015 Julien Viet
 *
 * 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.
 */

package io.termd.core.readline;

/**
 * A readline function.
 *
 * @author Julien Viet
 */
public interface Function {
  /**
   * The function name, for instance backward-char.
   */
  String name();

  /**
   * Apply the function on the current interaction.
   *
   * @param interaction the current interaction
   */
  void apply(Readline.Interaction interaction);

}