/* 
    P/P   *  Method: com.dmdirc.ui.input.tabstyles.TabCompletionStyle__static_init
          */
     1  /*
     2   * Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
     3   *
     4   * Permission is hereby granted, free of charge, to any person obtaining a copy
     5   * of this software and associated documentation files (the "Software"), to deal
     6   * in the Software without restriction, including without limitation the rights
     7   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8   * copies of the Software, and to permit persons to whom the Software is
     9   * furnished to do so, subject to the following conditions:
    10   *
    11   * The above copyright notice and this permission notice shall be included in
    12   * all copies or substantial portions of the Software.
    13   *
    14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    20   * SOFTWARE.
    21   */
    22  
    23  package com.dmdirc.ui.input.tabstyles;
    24  
    25  import com.dmdirc.ui.input.AdditionalTabTargets;
    26  
    27  /**
    28   * Defines the methods that should be implemented by tab completion styles.
    29   * Styles control the result of tab completing.
    30   * 
    31   * @author Chris
    32   */
    33  public interface TabCompletionStyle {
    34      
    35      /**
    36       * Retrieves this style's result for the specified parameters.
    37       * 
    38       * @param original The original string which the user inputted
    39       * @param start The start offset of the word that's being tab-completed
    40       * @param end The end offset of the word that's being tab-completed
    41       * @param additional A list of additional targets which may match
    42       * @return This style's proposed result
    43       */
    44      TabCompletionResult getResult(final String original, final int start,
    45              final int end, final AdditionalTabTargets additional);
    46      
    47  }