SDPepe/AppArt

package ch.epfl.sdp.appart.location.place.locality;

import java.util.regex.Pattern;

/**
 * This class is used to build localities.
 */
public class LocalityFactory {

    public static final String LOCALITY_PATTERN = "[a-zA-ZÀ-ÿ '-]+";
    public static final Pattern localityPattern =
            Pattern.compile(LOCALITY_PATTERN);

    /**
     * This makes a locality from a {@link String} containing a city.
     *
     * @param locality the city we want to build the locality from
     * @return the locality corresponding to the city given in argument
     */
    public static Locality makeLocality(String locality) {
        if (locality == null) throw new IllegalArgumentException();

        String localityFiltered = locality.trim();

        if (!localityPattern.matcher(localityFiltered).matches()) {
            throw new MalformedLocalityException("malformed locality string, " +
                    "expected format : " + LOCALITY_PATTERN + "but was :" + localityFiltered);
        }

        return new Locality(localityFiltered);
    }
}