Index (Mapcode Java Library 2.4.3 API)

A C D E F G H I L M P R T U V

A

Alphabet - Enum in com.mapcode: This enum defines all alphabets supported for mapcodes.

C

com.mapcode - package com.mapcode
containsTerritory(String) - Static method in class com.mapcode.Mapcode: Returns whether the mapcode contains territory information or not.

D

decode(String) - Static method in class com.mapcode.MapcodeCodec: Decode a mapcode to a Point.
decode(String, Territory) - Static method in class com.mapcode.MapcodeCodec: Decode a mapcode to a Point.
DEG_TO_MICRO_DEG - Static variable in class com.mapcode.Point
degreesLatToMeters(double) - Static method in class com.mapcode.Point
degreesLonToMetersAtLat(double, double) - Static method in class com.mapcode.Point
distanceInMeters(Point, Point) - Static method in class com.mapcode.Point: Calculate the distance between two points.

E

EARTH_CIRCUMFERENCE_X - Static variable in class com.mapcode.Point
EARTH_CIRCUMFERENCE_Y - Static variable in class com.mapcode.Point
EARTH_RADIUS_X_METERS - Static variable in class com.mapcode.Point
EARTH_RADIUS_Y_METERS - Static variable in class com.mapcode.Point
encode(double, double) - Static method in class com.mapcode.MapcodeCodec: Encode a lat/lon pair to a mapcode with territory information.
encode(Point) - Static method in class com.mapcode.MapcodeCodec
encode(double, double, Territory) - Static method in class com.mapcode.MapcodeCodec: Encode a lat/lon pair to a mapcode with territory information, for a specific territory.
encode(Point, Territory) - Static method in class com.mapcode.MapcodeCodec
encodeToInternational(double, double) - Static method in class com.mapcode.MapcodeCodec: Encode a lat/lon pair to its unambiguous, international mapcode.
encodeToInternational(Point) - Static method in class com.mapcode.MapcodeCodec
encodeToShortest(double, double, Territory) - Static method in class com.mapcode.MapcodeCodec: Encode a lat/lon pair to its shortest mapcode with territory information.
encodeToShortest(Point, Territory) - Static method in class com.mapcode.MapcodeCodec
equals(Object) - Method in class com.mapcode.Mapcode
equals(Object) - Method in class com.mapcode.Point

F

fromDeg(double, double) - Static method in class com.mapcode.Point: Create a point from lat/lon in degrees (may be precision!)
fromMicroDeg(int, int) - Static method in class com.mapcode.Point: Public construction, from integer microdegrees (no loss of precision).
fromString(String) - Static method in enum com.mapcode.Alphabet: Return alphabet from a string, which needs to be an alphanumeric code.
fromString(String) - Static method in enum com.mapcode.Territory: Get a territory from a mapcode territory abbreviation (or a territory name).
fromString(String, Territory) - Static method in enum com.mapcode.Territory: Get a territory from a name, specifying a parent territory for disambiguation.
fromUniformlyDistributedRandomPoints(Random) - Static method in class com.mapcode.Point: Create a random point, uniformly distributed over the surface of the Earth.

G

getAliases() - Method in enum com.mapcode.Territory: Return aliases (if any) for a territory.
getAlphabets() - Method in enum com.mapcode.Territory: Return the alphabets most commonly used in the territory, in order of importance.
getCode(Alphabet) - Method in class com.mapcode.Mapcode: Get the Mapcode string (without territory information) with standard precision.
getCode() - Method in class com.mapcode.Mapcode
getCode(int, Alphabet) - Method in class com.mapcode.Mapcode: Get the mapcode code (without territory information) with a specified precision.
getCode(int) - Method in class com.mapcode.Mapcode
getCode() - Method in exception com.mapcode.UnknownTerritoryException
getCodeWithTerritory(int, Alphabet) - Method in class com.mapcode.Mapcode: Return the international mapcode as a shorter version using the ISO territory codes where possible.
getCodeWithTerritory(int) - Method in class com.mapcode.Mapcode
getCodeWithTerritory(Alphabet) - Method in class com.mapcode.Mapcode
getCodeWithTerritory() - Method in class com.mapcode.Mapcode
getCodeWithTerritoryFullname(int, Alphabet) - Method in class com.mapcode.Mapcode: Return the full international mapcode, including the full name of the territory and the mapcode code itself.
getCodeWithTerritoryFullname(int) - Method in class com.mapcode.Mapcode
getCodeWithTerritoryFullname(Alphabet) - Method in class com.mapcode.Mapcode
getCodeWithTerritoryFullname() - Method in class com.mapcode.Mapcode
getFullName() - Method in enum com.mapcode.Territory: Return the full name of the territory.
getFullNameAliases() - Method in enum com.mapcode.Territory: Return aliases (if any) for the full name of a territory.
getLatDeg() - Method in class com.mapcode.Point: Get the latitude in degrees (may lose precision).
getLatMicroDeg() - Method in class com.mapcode.Point: Get latitude as micro-degrees.
getLonDeg() - Method in class com.mapcode.Point: Get the longitude in degrees (may lose precision).
getLonMicroDeg() - Method in class com.mapcode.Point: Get longitude as micro-degrees.
getParentTerritory() - Method in enum com.mapcode.Territory: Return the parent territory.
getPrecisionFormat(String) - Static method in class com.mapcode.Mapcode: This method return the mapcode type, given a mapcode string.
getSafeMaxOffsetInMeters(int) - Static method in class com.mapcode.Mapcode: Get a safe maximum for the distance between a decoded mapcode and its original location used for encoding the mapcode.
getTerritory() - Method in class com.mapcode.Mapcode: Get the territory information.

H

hashCode() - Method in class com.mapcode.Mapcode
hashCode() - Method in class com.mapcode.Point
hasSubdivisions() - Method in enum com.mapcode.Territory: Returns if this territory contains other territory subdivisions.

I

IncorrectDataModelException - Exception in com.mapcode: This runtime exception is thrown for unknown alphabet codes.
IncorrectDataModelException(String) - Constructor for exception com.mapcode.IncorrectDataModelException
isNearMultipleBorders(Point, Territory) - Static method in class com.mapcode.MapcodeCodec: Is coordinate near multiple territory borders?
isSubdivision() - Method in enum com.mapcode.Territory: Returns if this territory is a subdivisions of another territory.
isValidMapcodeFormat(String) - Static method in class com.mapcode.Mapcode: This method provides a shortcut to checking if a mapcode string is formatted properly or not at all.

L

LAT_DEG_MAX - Static variable in class com.mapcode.Point
LAT_DEG_MIN - Static variable in class com.mapcode.Point
LON_DEG_MAX - Static variable in class com.mapcode.Point
LON_DEG_MIN - Static variable in class com.mapcode.Point

M

Mapcode - Class in com.mapcode: This class defines a single mapcode encoding result, including the alphanumeric code and the territory definition.
Mapcode(String, Territory) - Constructor for class com.mapcode.Mapcode: Create a mapcode object.
MapcodeCodec - Class in com.mapcode: ---------------------------------------------------------------------------------------------- Mapcode public interface. ---------------------------------------------------------------------------------------------- This class is the external Java interface for encoding and decoding mapcodes.
METERS_PER_DEGREE_LAT - Static variable in class com.mapcode.Point
METERS_PER_DEGREE_LON_EQUATOR - Static variable in class com.mapcode.Point
metersToDegreesLonAtLat(double, double) - Static method in class com.mapcode.Point
MICRO_DEG_180 - Static variable in class com.mapcode.Point
MICRO_DEG_360 - Static variable in class com.mapcode.Point
MICRO_DEG_90 - Static variable in class com.mapcode.Point

P

PARENT_TERRITORIES - Static variable in enum com.mapcode.Territory
Point - Class in com.mapcode: This class defines a class for lat/lon points.

R

REGEX_MAPCODE - Static variable in class com.mapcode.Mapcode: This patterns/regular expressions is used for checking mapcode format strings.

T

Territory - Enum in com.mapcode: ---------------------------------------------------------------------------------------------- Mapcode public interface. ---------------------------------------------------------------------------------------------- This class defines the available territory codes as used by mapcode.
Territory.AlphaCodeFormat - Enum in com.mapcode: Enumeration that specifies the format for mapcodes.
toAlphaCode(Territory.AlphaCodeFormat, Alphabet) - Method in enum com.mapcode.Territory: Return the territory name, given a specific territory name format.
toAlphaCode(Territory.AlphaCodeFormat) - Method in enum com.mapcode.Territory
toString() - Method in class com.mapcode.Mapcode: This method is defined as returning the mapcode code including its territory, with normal precision (precision 0).
toString() - Method in class com.mapcode.Point
toString(Alphabet) - Method in enum com.mapcode.Territory: Return the international value of the territory name, with dashes rather than underscores.
toString() - Method in enum com.mapcode.Territory: Return the international value of the territory name, with dashes rather than underscores.

U

UnknownAlphabetException - Exception in com.mapcode: This runtime exception is thrown for unknown alphabet codes.
UnknownAlphabetException(String) - Constructor for exception com.mapcode.UnknownAlphabetException
UnknownMapcodeException - Exception in com.mapcode: This checked exception is thrown for invalid mapcodes (which have the right syntax, are correctly formatted).
UnknownMapcodeException(String) - Constructor for exception com.mapcode.UnknownMapcodeException
UnknownPrecisionFormatException - Exception in com.mapcode: This runtime exception is thrown for unknown alphabet codes.
UnknownPrecisionFormatException(String) - Constructor for exception com.mapcode.UnknownPrecisionFormatException
UnknownTerritoryException - Exception in com.mapcode: This runtime exception is thrown for unknown territory codes.
UnknownTerritoryException(String) - Constructor for exception com.mapcode.UnknownTerritoryException
UnknownTerritoryException(int) - Constructor for exception com.mapcode.UnknownTerritoryException

V

valueOf(String) - Static method in enum com.mapcode.Alphabet: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mapcode.Territory.AlphaCodeFormat: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mapcode.Territory: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.mapcode.Alphabet: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mapcode.Territory.AlphaCodeFormat: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mapcode.Territory: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E F G H I L M P R T U V