io.sphere.sdk.zones.Zone Maven / Gradle / Ivy
package io.sphere.sdk.zones;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.neovisionaries.i18n.CountryCode;
import io.sphere.sdk.models.Resource;
import io.sphere.sdk.models.Reference;
import javax.annotation.Nullable;
import java.util.Set;
/**
* Zones define Shipping Rates for a set of Locations.
*/
@JsonDeserialize(as = ZoneImpl.class)
public interface Zone extends Resource {
String getName();
@Nullable
String getDescription();
Set getLocations();
@Override
default Reference toReference() {
return Reference.of(referenceTypeId(), getId(), this);
}
static String referenceTypeId(){
return "zone";
}
/**
*
* @deprecated use {@link #referenceTypeId()} instead
* @return referenceTypeId
*/
@Deprecated
static String typeId(){
return "zone";
}
static TypeReference typeReference(){
return new TypeReference() {
@Override
public String toString() {
return "TypeReference";
}
};
}
/**
* Looks up the locations and checks if the country is present. It does not matter if the location has a state specified.
*
* @param countryCode the country to search for
* @return true if the country is somehow in the locations.
*/
default boolean contains(final CountryCode countryCode) {
return getLocations().stream().anyMatch(location -> location.getCountry().equals(countryCode));
}
}