com.esri.arcgis.system

Class DirectionFormat

java.lang.Object

com.esri.arcgis.system.DirectionFormat

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IAngularConverter2, IClone, IDirectionFormat, IDirectionFormatDestination, INumberFormat, INumberFormatOperations, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class DirectionFormat
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INumberFormat, INumberFormatOperations, IDirectionFormat, IDirectionFormatDestination, IAngularConverter2, IClone, IPersist, IPersistStream, java.io.Externalizable

COM Class 'DirectionFormat'. Generated 5/5/2025 2:28:32 PM from 'X:\ArcGIS\com\server\esriSystem.tlb'

Description 'An object for formatting numbers in a direction format.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.system.INumberFormat

IID, IID7e4f470d_8e54_11d2_aad8_000000000000, xxDummy

Fields inherited from interface com.esri.arcgis.system.INumberFormatOperations

IID, IID5ef43b7e_3bc1_4b25_a5c0_08218c75be06, xxDummy

Fields inherited from interface com.esri.arcgis.system.IDirectionFormat

IID, IID11d7b4c8_dbdf_4b98_ac6d_8c419efd2c24, xxDummy

Fields inherited from interface com.esri.arcgis.system.IDirectionFormatDestination

IID, IID3d6a01d6_b4e7_4e15_85e4_8a1e12885292, xxDummy

Fields inherited from interface com.esri.arcgis.system.IAngularConverter2

IID, IID95674ba9_3cd5_429d_a5ac_9d105a099cf7, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Constructor Summary

Constructors

Constructor and Description
DirectionFormat() Constructs a DirectionFormat using ArcGIS Engine.
DirectionFormat(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. DirectionFormat theDirectionFormat = (DirectionFormat) obj;

Method Summary

Modifier and Type	Method and Description
void	assign(IClone src) Assigns the properties of src to the receiver.
double	destinationStringToValue(java.lang.String str) Converts a formatted string to a numeric value using unit/type in destination and polar/radians as source
java.lang.String	destinationValueToString(double value) Converts a numeric value to a formatted string using unit/type in destination and polar/radians as source.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
int	getDecimalPlaces() The number of decimal digits in a seconds part of the formatted number.
int	getDirectionType() Indicates the direction of the argument in ValueToString.
int	getDirectionUnits() Indicates Direction Unit for the ValueToString argument.
int	getDisplayFormat() Indicates how to display the direction value.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
double	increment(double value) Increments a value according to the numbers format.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isNegativeAngles() Allow an angle to be converted from one direction unit to another.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	setDecimalPlaces(int num) The number of decimal digits in a seconds part of the formatted number.
void	setDirectionType(int direction) Indicates the direction of the argument in ValueToString.
void	setDirectionUnits(int unit) Indicates Direction Unit for the ValueToString argument.
void	setDisplayFormat(int directionFormat) Indicates how to display the direction value.
void	setNegativeAngles(boolean negAngles) Allow an angle to be converted from one direction unit to another.
double	stringToValue(java.lang.String str) Converts a formatted string to a numeric value.
java.lang.String	valueToString(double value) Converts a numeric value to a formatted string.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

DirectionFormat

public DirectionFormat()
                throws java.io.IOException,
                       java.net.UnknownHostException

Constructs a DirectionFormat using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

DirectionFormat

public DirectionFormat(java.lang.Object obj)
                throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DirectionFormat theDirectionFormat = (DirectionFormat) obj;

Construct a DirectionFormat using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to DirectionFormat.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

valueToString

public java.lang.String valueToString(double value)
                               throws java.io.IOException,
                                      AutomationException

Converts a numeric value to a formatted string.

Specified by:

valueToString in interface INumberFormat

Parameters:

value - The value (in)

Returns:

The str

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stringToValue

public double stringToValue(java.lang.String str)
                     throws java.io.IOException,
                            AutomationException

Converts a formatted string to a numeric value.

Specified by:

stringToValue in interface INumberFormat

Parameters:

str - The str (in)

Returns:

The value

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

increment

public double increment(double value)
                 throws java.io.IOException,
                        AutomationException

Increments a value according to the numbers format.

Specified by:

increment in interface INumberFormatOperations

Parameters:

value - The value (in)

Returns:

The result

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionUnits

public void setDirectionUnits(int unit)
                       throws java.io.IOException,
                              AutomationException

Indicates Direction Unit for the ValueToString argument.

Specified by:

setDirectionUnits in interface IDirectionFormat

Parameters:

unit - A com.esri.arcgis.system.esriDirectionUnits constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionUnits

public int getDirectionUnits()
                      throws java.io.IOException,
                             AutomationException

Indicates Direction Unit for the ValueToString argument.

Specified by:

getDirectionUnits in interface IDirectionFormat

Returns:

A com.esri.arcgis.system.esriDirectionUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionType

public void setDirectionType(int direction)
                      throws java.io.IOException,
                             AutomationException

Indicates the direction of the argument in ValueToString.

Specified by:

setDirectionType in interface IDirectionFormat

Parameters:

direction - A com.esri.arcgis.system.esriDirectionType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionType

public int getDirectionType()
                     throws java.io.IOException,
                            AutomationException

Indicates the direction of the argument in ValueToString.

Specified by:

getDirectionType in interface IDirectionFormat

Returns:

A com.esri.arcgis.system.esriDirectionType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayFormat

public void setDisplayFormat(int directionFormat)
                      throws java.io.IOException,
                             AutomationException

Indicates how to display the direction value.

Specified by:

setDisplayFormat in interface IDirectionFormat

Parameters:

directionFormat - A com.esri.arcgis.system.esriDirectionFormatEnum constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayFormat

public int getDisplayFormat()
                     throws java.io.IOException,
                            AutomationException

Indicates how to display the direction value.

Specified by:

getDisplayFormat in interface IDirectionFormat

Returns:

A com.esri.arcgis.system.esriDirectionFormatEnum constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDecimalPlaces

public void setDecimalPlaces(int num)
                      throws java.io.IOException,
                             AutomationException

The number of decimal digits in a seconds part of the formatted number.

Specified by:

setDecimalPlaces in interface IDirectionFormat

Parameters:

num - The num (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDecimalPlaces

public int getDecimalPlaces()
                     throws java.io.IOException,
                            AutomationException

The number of decimal digits in a seconds part of the formatted number.

Specified by:

getDecimalPlaces in interface IDirectionFormat

Returns:

The num

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

destinationValueToString

public java.lang.String destinationValueToString(double value)
                                          throws java.io.IOException,
                                                 AutomationException

Converts a numeric value to a formatted string using unit/type in destination and polar/radians as source.

Specified by:

destinationValueToString in interface IDirectionFormatDestination

Parameters:

value - The value (in)

Returns:

The str

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

destinationStringToValue

public double destinationStringToValue(java.lang.String str)
                                throws java.io.IOException,
                                       AutomationException

Converts a formatted string to a numeric value using unit/type in destination and polar/radians as source

Specified by:

destinationStringToValue in interface IDirectionFormatDestination

Parameters:

str - The str (in)

Returns:

The value

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNegativeAngles

public void setNegativeAngles(boolean negAngles)
                       throws java.io.IOException,
                              AutomationException

Allow an angle to be converted from one direction unit to another.

Specified by:

setNegativeAngles in interface IAngularConverter2

Parameters:

negAngles - The negAngles (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNegativeAngles

public boolean isNegativeAngles()
                         throws java.io.IOException,
                                AutomationException

Allow an angle to be converted from one direction unit to another.

Specified by:

isNegativeAngles in interface IAngularConverter2

Returns:

The negAngles

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException