io.github.julwas797.esaapi.common

Class SchoolEntry

java.lang.Object

io.github.julwas797.esaapi.common.SchoolEntry

public class SchoolEntry
extends Object

DTO containing data about specified school.
Part of APIEntry

Constructor Summary

Constructors

Constructor and Description
SchoolEntry(org.json.JSONObject jsonObject) Alternative constructor of school location DTO from JSONObject
SchoolEntry(String name, String street, int postalCode, String city, Coordinates coordinates) Default constructor for school DTO
SchoolEntry(String name, String street, int postalCode, String city, double longitude, double latitude) Alternative constructor, joining SchoolEntry(String, String, int, String, Coordinates) SchoolEntry} and Coordinates(double, double) Coordinates}.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Compares the equality of SchoolEntry
String	getCity() Returns String containing city the school is located in
Coordinates	getCoordinates() Returns Coordinates containing the school location
String	getName() Returns String containing school name
int	getPostalCode() Returns integer containing postal code of school
String	getStreet() Returns String containing street the school is located on
int	hashCode() Calculates hashcode of specific SchoolEntry
String	toString() Converts the following SchoolEntry to String

Methods inherited from class java.lang.Object

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

Constructor Detail

SchoolEntry

public SchoolEntry(String name,
                   String street,
                   int postalCode,
                   String city,
                   Coordinates coordinates)

Default constructor for school DTO

Parameters:

name - Name of the school

street - Street the school is located on

postalCode - Postal code of school

city - City the school is located in

coordinates - Coordinates representing the location of the school

SchoolEntry

public SchoolEntry(org.json.JSONObject jsonObject)

Alternative constructor of school location DTO from JSONObject

Parameters:

jsonObject - JSONObject containing school data.

SchoolEntry

public SchoolEntry(String name,
                   String street,
                   int postalCode,
                   String city,
                   double longitude,
                   double latitude)

Alternative constructor, joining SchoolEntry(String, String, int, String, Coordinates) SchoolEntry} and Coordinates(double, double) Coordinates}.

Parameters:

name - Name of the school

street - Street the school is located on

postalCode - Postal code of school

city - City the school is located in

longitude - Longitude of school location

latitude - Latitude of school location

Method Detail

getName

public String getName()

Returns String containing school name

Returns:

Name of the school

getStreet

public String getStreet()

Returns String containing street the school is located on

Returns:

Street the school is located on

getPostalCode

public int getPostalCode()

Returns integer containing postal code of school

Returns:

Postal code of school

getCity

public String getCity()

Returns String containing city the school is located in

Returns:

City the school is located in

getCoordinates

public Coordinates getCoordinates()

Returns Coordinates containing the school location

Returns:

Coordinates representing the location of the school

toString

public String toString()

Converts the following SchoolEntry to String

Overrides:

toString in class Object

Returns:

A serialized version of School DTO

equals

public boolean equals(Object o)

Compares the equality of SchoolEntry

Overrides:

equals in class Object

Parameters:

o - Object, presumably SchoolEntry

Returns:

Equality status

hashCode

public int hashCode()

Calculates hashcode of specific SchoolEntry

Overrides:

hashCode in class Object

Returns:

integer containing hashcode