com.esri.arcgis.system
Class ShortcutName

java.lang.Object
  com.esri.arcgis.system.ShortcutName

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IFileName, IName, IPersist, IPersistStream, IShortcutName, java.io.Externalizable, java.io.Serializable

public class ShortcutName
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IName, IFileName, IShortcutName, IPersistStream, java.io.Externalizable

COM Class 'ShortcutName'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriSystem.olb'

Description 'GxObject that represents the shortcut Name Object.' 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

static long

serialVersionUID

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

IID, IID53da75e0_d01a_11d2_9f27_00c04f6bc69e, xxDummy

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

IID, IIDe29b3c76_e7b2_458e_8732_e929391da234, 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

ShortcutName()
Constructs a ShortcutName using ArcGIS Engine.

ShortcutName(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ShortcutName theShortcutName = (ShortcutName) obj;

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getNameString() The name string of the object.
java.lang.String	getPath() Pathname to the file.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IName	getTargetName() The value of the TargetName property.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
java.lang.Object	open() Opens the object referred to by this name.
void	readExternal(java.io.ObjectInput in)
void	release() Release a ShortcutName.
void	save(IStream pstm, int fClearDirty) save
void	setNameString(java.lang.String nameString) The name string of the object.
void	setPath(java.lang.String path) Pathname to the file.
void	setTargetNameByRef(IName ppTargetName) The value of the TargetName property.
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

ShortcutName

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

Constructs a ShortcutName using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ShortcutName

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

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

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

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()

Deprecated. Internal use only.

Specified by:

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

release

public void release()

Release a ShortcutName.

Specified by:

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

setNameString

public void setNameString(java.lang.String nameString)
                   throws java.io.IOException,
                          AutomationException

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNameString in interface IName

Parameters:

nameString - The nameString (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNameString

public java.lang.String getNameString()
                               throws java.io.IOException,
                                      AutomationException

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNameString in interface IName

Returns:

The nameString

Throws:

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

AutomationException - If the ArcObject component throws an exception.

open

public java.lang.Object open()
                      throws java.io.IOException,
                             AutomationException

Opens the object referred to by this name.

Remarks

The Open method lets you instantiate the actual object given the name object.

Note: Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.

Example:

IName   pName = pFeatureClassName; 
pFeatureClass = new IFeatureClassProxy(pName.open());

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

open in interface IName

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPath

public void setPath(java.lang.String path)
             throws java.io.IOException,
                    AutomationException

Pathname to the file.

Specified by:

setPath in interface IFileName

Parameters:

path - The path (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPath

public java.lang.String getPath()
                         throws java.io.IOException,
                                AutomationException

Pathname to the file.

Specified by:

getPath in interface IFileName

Returns:

The path

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTargetName

public IName getTargetName()
                    throws java.io.IOException,
                           AutomationException

The value of the TargetName property.

Specified by:

getTargetName in interface IShortcutName

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTargetNameByRef

public void setTargetNameByRef(IName ppTargetName)
                        throws java.io.IOException,
                               AutomationException

The value of the TargetName property.

Specified by:

setTargetNameByRef in interface IShortcutName

Parameters:

ppTargetName - A reference to a com.esri.arcgis.system.IName (in)

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.

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.

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