/* 
    P/P   *  Method: com.dmdirc.ui.input.tabstyles.TabCompletionResult__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  /**
    26   * Details the proposed result of tab completion. Results consist of a
    27   * new string (to replace the current one), and a new caret position.
    28   */
    29  public class TabCompletionResult {
    30      
    31      /** The new string to use in the result. */
    32      private final String text;
    33      
    34      /** The new caret position to be used. */
    35      private final int position;
    36      
    37      /**
    38       * Creates a new instance of TabCompletionResult.
    39       *
    40       * @param text The text for this result
    41       * @param position The caret position for this result
    42       */
             /* 
    P/P       *  Method: void com.dmdirc.ui.input.tabstyles.TabCompletionResult(String, int)
              * 
              *  Postconditions:
              *    this.position == position
              *    init'ed(this.position)
              *    this.text == text
              *    init'ed(this.text)
              */
    43      public TabCompletionResult(final String text, final int position) {
    44          this.text = text;
    45          this.position = position;
    46      }
    47      
    48      /**
    49       * Retrieves the replacement string for this result.
    50       *
    51       * @return This result's text
    52       */
    53      public String getText() {
                 /* 
    P/P           *  Method: String getText()
                  * 
                  *  Postconditions:
                  *    return_value == this.text
                  *    init'ed(return_value)
                  */
    54          return text;
    55      }
    56      
    57      /**
    58       * Retrieves the new caret position for this result.
    59       *
    60       * @return This result's caret position
    61       */
    62      public int getPosition() {
                 /* 
    P/P           *  Method: int getPosition()
                  * 
                  *  Postconditions:
                  *    return_value == this.position
                  *    init'ed(return_value)
                  */
    63          return position;
    64      }
    65      
    66  }