/* 
    P/P   *  Method: com.dmdirc.util.StringTranscoder__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.util;
    24  
    25  import java.nio.charset.Charset;
    26  
    27  /**
    28   * Facilitates easy transcoding of strings.
    29   * 
    30   * @author Chris
    31   */
    32  public class StringTranscoder {
    33     
    34      /** The charset that is used by this transcoder. */
    35      private final Charset charset;
    36      
    37      /**
    38       * Creates a new StringTranscoder that will transcode strings from the
    39       * system's default character set into the specified charset.
    40       * 
    41       * @param charset The target character set
    42       */
             /* 
    P/P       *  Method: void com.dmdirc.util.StringTranscoder(Charset)
              * 
              *  Postconditions:
              *    this.charset == charset
              *    init'ed(this.charset)
              */
    43      public StringTranscoder(final Charset charset) {
    44          this.charset = charset;
    45      }
    46      
    47      /**
    48       * Transcodes the specified string from the system's default charset to
    49       * this transcoder's charset.
    50       * 
    51       * @param string The string to be transcoded
    52       * @return A new string of the appropriate charset
    53       */
    54      public String encode(final String string) {
                 /* 
    P/P           *  Method: String encode(String)
                  * 
                  *  Preconditions:
                  *    string != null
                  * 
                  *  Postconditions:
                  *    return_value == &new String(encode#1)
                  *    new String(encode#1) num objects == 1
                  */
    55          return new String(string.getBytes(charset));
    56      }
    57      
    58      /**
    59       * Transcodes the specified string from this transcoder's charset to the
    60       * system's default charset
    61       * 
    62       * @param string The string to be transcoded
    63       * @return A new string of the appropriate charset
    64       */
    65      public String decode(final String string) {
                 /* 
    P/P           *  Method: String decode(String)
                  * 
                  *  Preconditions:
                  *    string != null
                  * 
                  *  Postconditions:
                  *    return_value == &new String(decode#1)
                  *    new String(decode#1) num objects == 1
                  */
    66          return new String(string.getBytes(), charset);
    67      }    
    68      
    69  }