<?xml version="1.0" encoding="UTF-8"?>
<root>
    <doclet-version-NOT-library-version>1.07</doclet-version-NOT-library-version>
    <class>
        <name>com.google.openlocationcode.OpenLocationCode</name>
        <comment>Convert locations to and from convenient short codes.

 &lt;p&gt;Open Location Codes are short, ~10 character codes that can be used instead of street
 addresses. The codes can be generated and decoded offline, and use a reduced character set that
 minimises the chance of codes including words.

 &lt;p&gt;This provides both object and static methods.

 &lt;p&gt;Create an object with: OpenLocationCode code = new OpenLocationCode("7JVW52GR+2V");
 OpenLocationCode code = new OpenLocationCode("52GR+2V"); OpenLocationCode code = new
 OpenLocationCode(27.175063, 78.042188); OpenLocationCode code = new OpenLocationCode(27.175063,
 78.042188, 11);

 &lt;p&gt;Once you have a code object, you can apply the other methods to it, such as to shorten:
 code.shorten(27.176, 78.05)

 &lt;p&gt;Recover the nearest match (if the code was a short code): code.recover(27.176, 78.05)

 &lt;p&gt;Or decode a code into its coordinates, returning a CodeArea object. code.decode()</comment>
        <owner>process</owner>
        <method>
            <name>encode</name>
            <comment>Encodes latitude/longitude into 10 digit Open Location Code. This method is equivalent to
 creating the OpenLocationCode object and getting the code from it.
latitude: The latitude in decimal degrees.
longitude: The longitude in decimal degrees.
Return type: @return:The code.</comment>
            <returntype>java.lang.String</returntype>
            <parameter>
                <name>latitude</name>
                <type>double</type>
            </parameter>
            <parameter>
                <name>longitude</name>
                <type>double</type>
            </parameter>
        </method>
        <method>
            <name>isFullCode</name>
            <comment>Returns if the code is a valid full Open Location Code.
code: The code to check.
Return type: @return:True if it is a valid full code.</comment>
            <returntype>boolean</returntype>
            <parameter>
                <name>code</name>
                <type>java.lang.String</type>
            </parameter>
        </method>
        <method>
            <name>recover</name>
            <comment>Returns an {@link OpenLocationCode} object representing a full Open Location Code from this
 (short) Open Location Code, given the reference location.
referenceLatitude: Degrees.
referenceLongitude: Degrees.
Return type: @return:The nearest matching full code.</comment>
            <returntype>com.google.openlocationcode.OpenLocationCode</returntype>
            <parameter>
                <name>referenceLatitude</name>
                <type>double</type>
            </parameter>
            <parameter>
                <name>referenceLongitude</name>
                <type>double</type>
            </parameter>
        </method>
        <method>
            <name>isPadded</name>
            <comment>Returns whether the provided Open Location Code is a padded Open Location Code, meaning that it
 contains less than 8 valid digits.
code: The code to check.
Return type: @return:True if it is padded.</comment>
            <returntype>boolean</returntype>
            <parameter>
                <name>code</name>
                <type>java.lang.String</type>
            </parameter>
        </method>
        <method>
            <name>isShortCode</name>
            <comment>Returns if the code is a valid short Open Location Code.
code: The code to check.
Return type: @return:True if it is a valid short code.</comment>
            <returntype>boolean</returntype>
            <parameter>
                <name>code</name>
                <type>java.lang.String</type>
            </parameter>
        </method>
        <method>
            <name>decode</name>
            <comment>Decodes {@link OpenLocationCode} object into {@link CodeArea} object encapsulating
 latitude/longitude bounding box.
Return type: @return:A CodeArea object.</comment>
            <returntype>com.google.openlocationcode.OpenLocationCode.CodeArea</returntype>
        </method>
        <method>
            <name>contains</name>
            <comment>Returns whether the bounding box specified by the Open Location Code contains provided point.
latitude: Degrees.
longitude: Degrees.
Return type: @return:True if the coordinates are contained by the code.</comment>
            <returntype>boolean</returntype>
            <parameter>
                <name>latitude</name>
                <type>double</type>
            </parameter>
            <parameter>
                <name>longitude</name>
                <type>double</type>
            </parameter>
        </method>
        <method>
            <name>shorten</name>
            <comment>Returns short {@link OpenLocationCode} from the full Open Location Code created by removing
 four or six digits, depending on the provided reference point. It removes as many digits as
 possible.
referenceLatitude: Degrees.
referenceLongitude: Degrees.
Return type: @return:A short code if possible.</comment>
            <returntype>com.google.openlocationcode.OpenLocationCode</returntype>
            <parameter>
                <name>referenceLatitude</name>
                <type>double</type>
            </parameter>
            <parameter>
                <name>referenceLongitude</name>
                <type>double</type>
            </parameter>
        </method>
        <method>
            <name>hashCode</name>
            <comment></comment>
            <returntype>int</returntype>
        </method>
        <method>
            <name>isValidCode</name>
            <comment>Returns whether the provided string is a valid Open Location code.
code: The code to check.
Return type: @return:True if it is a valid full or short code.</comment>
            <returntype>boolean</returntype>
            <parameter>
                <name>code</name>
                <type>java.lang.String</type>
            </parameter>
        </method>
        <method>
            <name>equals</name>
            <comment></comment>
            <returntype>boolean</returntype>
            <parameter>
                <name>o</name>
                <type>java.lang.Object</type>
            </parameter>
        </method>
        <method>
            <name>toString</name>
            <comment></comment>
            <returntype>java.lang.String</returntype>
        </method>
        <method>
            <name>isFull</name>
            <comment>Returns whether this {@link OpenLocationCode} is a full Open Location Code.
Return type: @return:True if it is a full code.</comment>
            <returntype>boolean</returntype>
        </method>
        <method>
            <name>isShort</name>
            <comment>Returns whether this {@link OpenLocationCode} is a short Open Location Code.
Return type: @return:True if it is short.</comment>
            <returntype>boolean</returntype>
        </method>
        <property>
            <name>Code</name>
            <returntype>java.lang.String</returntype>
            <comment>Returns the string representation of the code.</comment>
        </property>
        <field>
            <name>CODE_PRECISION_NORMAL</name>
            <comment></comment>
            <returntype>int</returntype>
        </field>
        <field>
            <name>SEPARATOR</name>
            <comment></comment>
            <returntype>char</returntype>
        </field>
        <field>
            <name>MAX_DIGIT_COUNT</name>
            <comment></comment>
            <returntype>int</returntype>
        </field>
        <field>
            <name>PADDING_CHARACTER</name>
            <comment></comment>
            <returntype>char</returntype>
        </field>
        <field>
            <name>CODE_ALPHABET</name>
            <comment></comment>
            <returntype>java.lang.String</returntype>
        </field>
    </class>
    <class>
        <name>com.google.openlocationcode.OpenLocationCode.CodeArea</name>
        <comment>Coordinates of a decoded Open Location Code.

 &lt;p&gt;The coordinates include the latitude and longitude of the lower left and upper right corners
 and the center of the bounding box for the area the code represents.</comment>
        <owner>process</owner>
        <property>
            <name>CenterLongitude</name>
            <returntype>double</returntype>
            <comment></comment>
        </property>
        <property>
            <name>WestLongitude</name>
            <returntype>double</returntype>
            <comment></comment>
        </property>
        <property>
            <name>EastLongitude</name>
            <returntype>double</returntype>
            <comment></comment>
        </property>
        <property>
            <name>NorthLatitude</name>
            <returntype>double</returntype>
            <comment></comment>
        </property>
        <property>
            <name>Length</name>
            <returntype>int</returntype>
            <comment></comment>
        </property>
        <property>
            <name>SouthLatitude</name>
            <returntype>double</returntype>
            <comment></comment>
        </property>
        <property>
            <name>LongitudeWidth</name>
            <returntype>double</returntype>
            <comment></comment>
        </property>
        <property>
            <name>LatitudeHeight</name>
            <returntype>double</returntype>
            <comment></comment>
        </property>
        <property>
            <name>CenterLatitude</name>
            <returntype>double</returntype>
            <comment></comment>
        </property>
    </class>
</root>
