<commit_before>/*
 * (c) Copyright 2016 FFB Depot Client Developers.
 *
 * This file is part of FFB Depot Client.
 *
 * FFB Depot Client is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * FFB Depot Client is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with FFB Depot Client.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

package de.bmarwell.ffb.depot.client.value;

import java.util.Arrays;

/**
 * Die Pin, die für das Login zusammen mit der {@link FfbLoginKennung} bei der FFB verwendet wird.
 *
 * <p>Sie wird intern im Speicher als CharArray zwischengespeichert, damit sie nicht ganz so offensichtlich im Speicher
 * liegt. Hier ist aber noch Optimierungspotential. Im Gegensatz zu z.B. Hibiscus selbst wird aber die Login nur so lange wie
 * notwendig im Speicher gehalten, und ist als CharArray nicht sofort als PIN ersichtlich.</p>
 */
public class FfbPin {

  /**
   * Die Pin wird als Char-Array gespeichert, damit sie wenigstens nicht komplett offensichtlich im Speicher liegt.
   */
  private char[] pin;

  public FfbPin(char[] pin) {
    // Should store a copy, so the pin won't change while working with it.
    this.pin = Arrays.copyOf(pin, pin.length);
  }

  /**
   * Konstruktur für das Immutable-Objekt der Ffb-PIN.
   *
   * <p>Diese Methode ist gleichwertig zu {@link #of(char[])}, da einfach hier {@link String#toCharArray()} aufgerufen wird.
   *
   * @param pin
   *          die Pin als String.
   * @return eine FfbPin, immutable.
   */
  public static FfbPin of(String pin) {
    return new FfbPin(pin.toCharArray());
  }

  /**
   * Konstruktur für das Immutable-Objekt der Ffb-PIN.
   *
   * @param pin
   *          die Pin als char[].
   * @return eine FfbPin, immutable.
   */
  public static FfbPin of(char[] pin) {
    return new FfbPin(pin);
  }

  public String getPinAsString() {
    return new String(pin);
  }
}<commit_msg>[#6]: FfbPin as ValueObject using Immutables.<commit_after>/*
 * (c) Copyright 2016 FFB Depot Client Developers.
 *
 * This file is part of FFB Depot Client.
 *
 * FFB Depot Client is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * FFB Depot Client is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with FFB Depot Client.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

package de.bmarwell.ffb.depot.client.value;

import org.immutables.value.Value;

/**
 * Die Pin, die für das Login zusammen mit der {@link FfbLoginKennung} bei der FFB verwendet wird.
 *
 * <p>Sie wird intern im Speicher als CharArray zwischengespeichert, damit sie nicht ganz so offensichtlich im Speicher
 * liegt. Hier ist aber noch Optimierungspotential. Im Gegensatz zu z.B. Hibiscus selbst wird aber die Login nur so lange wie
 * notwendig im Speicher gehalten, und ist als CharArray nicht sofort als PIN ersichtlich.</p>
 */
@Value.Immutable
public abstract class FfbPin {

  @Value.Parameter
  public abstract char[] getPin();

  /**
   * Konstruktur für das Immutable-Objekt der Ffb-PIN.
   *
   * <p>Diese Methode ist gleichwertig zu {@link #of(char[])}, da einfach hier {@link String#toCharArray()} aufgerufen wird.
   *
   * @param pin
   *          die Pin als String.
   * @return eine FfbPin, immutable.
   */
  public static FfbPin of(final String pin) {
    return ImmutableFfbPin.of(pin.toCharArray());
  }

  /**
   * Konstruktur für das Immutable-Objekt der Ffb-PIN.
   *
   * @param pin
   *          die Pin als char[].
   * @return eine FfbPin, immutable.
   */
  public static FfbPin of(final char[] pin) {
    return ImmutableFfbPin.of(pin);
  }

  public String getPinAsString() {
    return new String(getPin());
  }
}
{'fraction_non_alphanumeric': 0.08807829181494661, 'fraction_numerical': 0.0024466192170818505, 'mean_word_length': 3.282857142857143, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4738647', 'n_tokens_mistral': 1398, 'n_tokens_neox': 1398, 'n_words': 565}