Package net.datafaker.providers.base

Class Compass

java.lang.Object

net.datafaker.providers.base.AbstractProvider<BaseProviders>

net.datafaker.providers.base.Compass

public class Compass
extends AbstractProvider<BaseProviders>

Since:

1.7.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Compass.CompassPoint

Field Summary

Fields inherited from class net.datafaker.providers.base.AbstractProvider

faker

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Compass(BaseProviders faker)

Method Summary

Modifier and Type	Method	Description
String	abbreviation()	Returns abbreviation of direction according to the specified Compass.CompassPoint point of direction.
String	azimuth()	Returns appropriate azimuth of direction according to the specified Compass.CompassPoint point of direction.
Compass	compassPoint(Compass.CompassPoint compassPoint)	Specify point of direction.
String	word()	Returns full-size name of direction according to the specified Compass.CompassPoint point of direction.

Methods inherited from class net.datafaker.providers.base.AbstractProvider

equals, getFaker, hashCode, resolve, resolve

Methods inherited from class java.lang.Object

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

Constructor Details

Compass

protected Compass(BaseProviders faker)

Method Details

compassPoint

public Compass compassPoint(Compass.CompassPoint compassPoint)

Specify point of direction. If not specified, point of direction will be randomly selected.

Parameters:

compassPoint - point of direction.

Returns:

itself with specified point of direction.

See Also:

• Compass.CompassPoint

word

public String word()

Returns full-size name of direction according to the specified Compass.CompassPoint point of direction.

Specify point of direction using compassPoint(CompassPoint) method.

Typical call of this method: compass().compassPoint(CompassPoint.CARDINAL).word();

Returns:

the full-size direction word according to the specified Compass.CompassPoint. Otherwise, the point of direction will be selected randomly.

abbreviation

public String abbreviation()

Returns abbreviation of direction according to the specified Compass.CompassPoint point of direction.

Specify point of direction using compassPoint(CompassPoint) method.

Typical call of this method: compass().compassPoint(CompassPoint.CARDINAL).abbreviation();

Returns:

the abbreviation of direction according to the specified Compass.CompassPoint. Otherwise, the point of direction will be selected randomly.

azimuth

public String azimuth()

Returns appropriate azimuth of direction according to the specified Compass.CompassPoint point of direction.

Specify point of direction using compassPoint(CompassPoint) method.

Typical call of this method: compass().compassPoint(CompassPoint.CARDINAL).azimuth();

Returns:

the appropriate azimuth of the direction according to the specified Compass.CompassPoint. Otherwise, the point of direction will be selected randomly.