java.lang.Object
- gov.usgs.earthquake.nshmp.geo.json.Feature

```
public class Feature
extends Object
```
A GeoJSON feature.
This class provides factory methods to create single-use GeoJSON feature builders for different geometries.
See GeoJson for examples.

Author:

U.S. Geological Survey

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Feature.Builder
A single-use feature builder.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`LocationList`	`asLineString()`	Return the geometry of this feature as a line string.
`List<LocationList>`	`asMultiLineString()`	Return the geometry of the feature as multi-line string.
`Location`	`asPoint()`	Return the geometry of this feature as a point.
`LocationList`	`asPolygonBorder()`	Return the border of this polygon feature.
`Optional<double[]>`	`bbox()`	The bounding box value array; If bbox is `null`, returns Optional.empty(), else returns an `Optional<double[]>` copy of the bbox value array.
`static Feature.Builder`	`copyOf(Feature feature)`	Create a single-use feature builder with the geometry, id, and bounding box of the supplied feature.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`OptionalInt`	`idAsInt()`	The 'id' of this feature as a `OptionalInt`.
`Optional<String>`	`idAsString()`	The 'id' of this feature as a `Optional<String>`.
`static Feature.Builder`	`lineString(LocationList line)`	Create a single-use line string feature builder.
`static Feature.Builder`	`multiLineString(List<LocationList> multiLine)`	Create a single-use multi-line string feature builder.
`static Feature.Builder`	`point(Location location)`	Create a single-use point feature builder.
`static Feature.Builder`	`polygon(LocationList exterior, LocationList... interiors)`	Create a single-use polygon feature builder.
`Properties`	`properties()`	Get the property map associated with this feature as a `Properties` helper object.
`String`	`toJson()`	Return the serialized form of this GeoJSON feature.
`com.google.gson.JsonElement`	`toJsonTree()`	Returns the `Feature` as a `JsonElement`.
`GeoJson.Type`	`type()`	The GeoJSON geometry type of this feature, one of: `[POINT, LINE_STRING, POLYGON, MULTI_LINE_STRING]`.
`void`	`write(Path path)`	Write the serialized form of this GeoJSON feature to the file at `path`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - point
```
public static Feature.Builder point(Location location)
```
    Create a single-use point feature builder.
    
    Parameters:
    
    location - of point
  - lineString
```
public static Feature.Builder lineString(LocationList line)
```
    Create a single-use line string feature builder.
    
    Parameters:
    
    line - locations
  - multiLineString
```
public static Feature.Builder multiLineString(List<LocationList> multiLine)
```
    Create a single-use multi-line string feature builder.
    
    Parameters:
    
    multiLine - locations
  - polygon
```
public static Feature.Builder polygon(LocationList exterior,
                                      LocationList... interiors)
```
    Create a single-use polygon feature builder.
    
    Parameters:
    
    exterior - linear ring boundary of polygon
    
    interiors - optional interior linear rings
  - copyOf
```
public static Feature.Builder copyOf(Feature feature)
```
    Create a single-use feature builder with the geometry, id, and bounding box of the supplied feature. The properties of the supplied feature are not copied. Use Properties.fromFeature(Feature) to build a new property map from those in the supplied feature.
    
    Parameters:
    
    feature - to copy into builder
    
    See Also:
    
    Properties.fromFeature(Feature)
  - idAsString
```
public Optional<String> idAsString()
```
    The 'id' of this feature as a Optional<String>. If this feature does not contain an 'id' member, return Optional.empty().
  - idAsInt
```
public OptionalInt idAsInt()
```
    The 'id' of this feature as a OptionalInt. If this feature does not contain an 'id' member, return OptionalInt.empty().
  - bbox
```
public Optional<double[]> bbox()
```
    The bounding box value array; If bbox is null, returns Optional.empty(), else returns an Optional<double[]> copy of the bbox value array.
  - properties
```
public Properties properties()
```
    Get the property map associated with this feature as a Properties helper object. May be null or empty.
  - type
```
public GeoJson.Type type()
```
    The GeoJSON geometry type of this feature, one of: [POINT, LINE_STRING, POLYGON, MULTI_LINE_STRING].
    
    See Also:
    
    GeoJson.Type
  - asPoint
```
public Location asPoint()
```
    Return the geometry of this feature as a point.
    
    Throws:
    
    UnsupportedOperationException - if feature is not a point.
  - asLineString
```
public LocationList asLineString()
```
    Return the geometry of this feature as a line string.
    
    Throws:
    
    UnsupportedOperationException - if feature is not a line string.
  - asMultiLineString
```
public List<LocationList> asMultiLineString()
```
    Return the geometry of the feature as multi-line string.
    
    Throws:
    
    UnsupportedOperationException - if feature is not a multi-line string.
  - asPolygonBorder
```
public LocationList asPolygonBorder()
```
    Return the border of this polygon feature.
    
    Throws:
    
    UnsupportedOperationException - if feature is not a polygon.
  - toJson
```
public String toJson()
```
    Return the serialized form of this GeoJSON feature.
  - toJsonTree
```
public com.google.gson.JsonElement toJsonTree()
```
    Returns the Feature as a JsonElement.
  - write
```
public void write(Path path)
           throws IOException
```
    Write the serialized form of this GeoJSON feature to the file at path.
    
    Throws:
    
    IOException
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class Feature

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

point

lineString

multiLineString

polygon

copyOf

idAsString

idAsInt

bbox

properties

type

asPoint

asLineString

asMultiLineString

asPolygonBorder

toJson

toJsonTree

write

hashCode

equals