/* 
    P/P   *  Method: com.dmdirc.updater.UpdateComponent__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.updater;
    24  
    25  /**
    26   * The update component interface defines the methods needed to be implemented
    27   * by updatable components. The components handle determining the current
    28   * version and installing updated files.
    29   * 
    30   * @author chris
    31   */
    32  public interface UpdateComponent {
    33      
    34      /**
    35       * Retrieves the name of this component.
    36       * 
    37       * @return This component's name
    38       */
    39      String getName();
    40      
    41      /**
    42       * A user-friendly name displayed for the component.
    43       * 
    44       * @return This component's user-friendly name
    45       */
    46      String getFriendlyName();
    47      
    48      /**
    49       * A user-friendly version displayed for the component.
    50       *
    51       * @return This component's user-friendly version
    52       * @since 0.6
    53       */
    54      String getFriendlyVersion();
    55  
    56      /**
    57       * Retrieves the currently installed version of this component.
    58       * 
    59       * @return This component's current version
    60       * @since 0.6.3m1
    61       */
    62      Version getVersion();
    63      
    64      /**
    65       * Installs the updated version of this component. After the update has
    66       * been installed, the component is responsible for deleting the specified
    67       * file.
    68       * 
    69       * @param path The full path to the downloaded data
    70       * @return True if a client restart is needed, false otherwise
    71       * @throws java.lang.Throwable If any error occured
    72       */
    73      boolean doInstall(String path) throws Throwable;
    74  
    75  }