de.jfachwert.post.Adressat.java Source code

Introduction

Here is the source code for de.jfachwert.post.Adressat.java

Source

/*
 * Copyright (c) 2018 by Oliver Boehm
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * (c)reated 18.01.2018 by oboehm (ob@oasd.de)
 */
package de.jfachwert.post;

import de.jfachwert.Text;
import de.jfachwert.pruefung.LengthValidator;
import org.apache.commons.lang3.StringUtils;

import java.util.WeakHashMap;

/**
 * Ein Adressat (oder auch Postempfaenger) ist diejenige Person, die in der
 * Adresse benannt ist und fr die damit eine Postsendung bestimmt ist. 
 * Hierbei kann es sich um eine natuerliche oder um eine juristische Person 
 * handeln.
 *
 * @author oboehm
 * @since 0.5 (18.01.2018)
 */
public class Adressat extends Text {

    private static final WeakHashMap<String, Adressat> WEAK_CACHE = new WeakHashMap<>();

    /**
     * Erzeugt eine Adressat mit dem angegebenen Namen. Dabei kann es sich um
     * eine natuerliche Person (z.B. "Mustermann, Max") oder eine juristische
     * Person (z.B. "Ich AG") handeln.
     * <p>
     * Das Format des Adressat ist so, wie er auf dem Brief angegeben wird:
     * "Nachname, Vorname" bei Personen bzw. Name bei juristischen Personen.
     * </p>
     * 
     * @param name z.B. "Mustermann, Max"
     */
    public Adressat(String name) {
        super(name, LengthValidator.NOT_EMPTY_VALIDATOR);
    }

    /**
     * Liefert einen Adressat mit dem angegebenen Namen.
     * 
     * @param name z.B. "Mustermann, Max"
     * @return Addressat mit dem angegebenen Namen
     */
    public static Adressat of(String name) {
        return WEAK_CACHE.computeIfAbsent(name, Adressat::new);
    }

    /**
     * Der Name ist der Teil vor dem Komma (bei Personen). Bei Firmen ist
     * es der komplette Name.
     * 
     * @return z.B. "Mustermann"
     */
    public String getName() {
        return StringUtils.substringBefore(this.getCode(), ",").trim();
    }

    /**
     * Bei natuerlichen Personen mit Vornamen kann hierueber der Vorname
     * ermittelt werden.
     * 
     * @return z.B. "Max"
     */
    public String getVorname() {
        if (hasVorname()) {
            return StringUtils.substringAfter(this.getCode(), ",").trim();
        } else {
            throw new IllegalStateException("keine nat\u00fcrliche Person: " + this.getCode());
        }
    }

    /**
     * Bei natuerlichen Personen wird Nachname vom Vorname durch ein Komma
     * getrennt. Dies wird hier fuer die Pruefung herangezogen.
     * 
     * @return true bei natuerlichen Personen mit Vornamen
     */
    public boolean hasVorname() {
        return this.getCode().contains(",");
    }

}