io.redlink.geocoding.Place Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2017-2022 Redlink GmbH.
 *
 * 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.
 */
package io.redlink.geocoding;

import java.util.Collection;
import java.util.Map;
import java.util.Objects;
import java.util.Set;

/**
 * A Place on Earth - in most cases.
 */
public final class Place {

    private final String placeId;
    private final String address;
    private final LatLon latLon;

    private final Collection components;
    private final Map metadata;

    private Place(String placeId, String address, LatLon latLon, Collection components, Map metadata) {
        this.placeId = placeId;
        this.address = address;
        this.latLon = latLon;
        this.components = components;
        this.metadata = metadata;
    }

    public String getPlaceId() {
        return placeId;
    }

    public String getAddress() {
        return address;
    }

    public LatLon getLatLon() {
        return latLon;
    }

    public Collection getComponents() {
        return Set.copyOf(components);
    }

    public Map getMetadata() {
        return Map.copyOf(metadata);
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof Place)) return false;
        Place place = (Place) o;
        return Objects.equals(placeId, place.placeId) &&
                Objects.equals(address, place.address) &&
                Objects.equals(latLon, place.latLon) &&
                Objects.equals(components, place.components) &&
                Objects.equals(metadata, place.metadata);
    }

    @Override
    public int hashCode() {
        return Objects.hash(placeId, address, latLon, components, metadata);
    }

    @Override
    public String toString() {
        return "Place{" +
                "placeId='" + placeId + '\'' +
                ", address='" + address + '\'' +
                ", latLon=" + latLon +
                '}';
    }

    public static Place create(String placeId, String address, LatLon latLon) {
        return create(placeId, address, latLon, Set.of(), Map.of());
    }

    public static Place create(String placeId, String address, LatLon latLon,
                               Collection addressComponents, Map metadata) {
        return new Place(placeId, address, latLon, addressComponents, metadata);
    }
}