Package org.localify.dto.geocoding

Record Class PlaceResults.Place

java.lang.Object

java.lang.Record

org.localify.dto.geocoding.PlaceResults.Place

Record Components:

coordinate - The coordinate of the place.

displayMapRegion - The display map region for the place.

name - The name of the place.

formattedAddressLines - The formatted address lines for the place.

structuredAddress - The structured address for the place.

country - The country of the place.

countryCode - The country code of the place.

Enclosing class:

PlaceResults

public static record PlaceResults.Place(PlaceResults.Coordinate coordinate, PlaceResults.DisplayMapRegion displayMapRegion, String name, List<String> formattedAddressLines, PlaceResults.StructuredAddress structuredAddress, String country, String countryCode)
extends Record

Represents a place result from the geocoding API.

Constructor Summary

Constructors

Constructor	Description
Place(PlaceResults.Coordinate coordinate, PlaceResults.DisplayMapRegion displayMapRegion, String name, List<String> formattedAddressLines, PlaceResults.StructuredAddress structuredAddress, String country, String countryCode)	Creates an instance of a Place record class.

Method Summary

Modifier and Type	Method	Description
PlaceResults.Coordinate	coordinate()	Returns the value of the coordinate record component.
String	country()	Returns the value of the country record component.
String	countryCode()	Returns the value of the countryCode record component.
PlaceResults.DisplayMapRegion	displayMapRegion()	Returns the value of the displayMapRegion record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<String>	formattedAddressLines()	Returns the value of the formattedAddressLines record component.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
PlaceResults.StructuredAddress	structuredAddress()	Returns the value of the structuredAddress record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Place

public Place(PlaceResults.Coordinate coordinate,
 PlaceResults.DisplayMapRegion displayMapRegion,
 String name,
 List<String> formattedAddressLines,
 PlaceResults.StructuredAddress structuredAddress,
 String country,
 String countryCode)

Creates an instance of a Place record class.

Parameters:

coordinate - the value for the coordinate record component

displayMapRegion - the value for the displayMapRegion record component

name - the value for the name record component

formattedAddressLines - the value for the formattedAddressLines record component

structuredAddress - the value for the structuredAddress record component

country - the value for the country record component

countryCode - the value for the countryCode record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

coordinate

public PlaceResults.Coordinate coordinate()

Returns the value of the coordinate record component.

Returns:

the value of the coordinate record component

displayMapRegion

public PlaceResults.DisplayMapRegion displayMapRegion()

Returns the value of the displayMapRegion record component.

Returns:

the value of the displayMapRegion record component

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

formattedAddressLines

public List<String> formattedAddressLines()

Returns the value of the formattedAddressLines record component.

Returns:

the value of the formattedAddressLines record component

structuredAddress

public PlaceResults.StructuredAddress structuredAddress()

Returns the value of the structuredAddress record component.

Returns:

the value of the structuredAddress record component

country

public String country()

Returns the value of the country record component.

Returns:

the value of the country record component

countryCode

public String countryCode()

Returns the value of the countryCode record component.

Returns:

the value of the countryCode record component