com.esri.arcgis.system

Class FileNames

java.lang.Object

com.esri.arcgis.system.FileNames

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IFileNames, IFileNames2, java.io.Serializable

public class FileNames
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IFileNames, IFileNames2

COM Class 'FileNames'. Generated 9/21/2023 10:01:43 AM from 'X:\ArcGIS\com\server\esriSystem.tlb'

Description 'FileNames object maintains an array of file paths.' 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 inherited from interface com.esri.arcgis.system.IFileNames

IID, IIDf6ed3377_94f5_11d1_9ab0_080009ec734b, xxDummy

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

IID, IID1f1197e3_b3bb_4d9c_b530_923e39efce11, xxDummy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String fileName) Adds a filename to the array.
boolean	equals(java.lang.Object o) Compare this object with another
boolean	find(java.lang.String fileName) Advances the current postion to the specified file if it exists.
static java.lang.String	getClsid() getClsid.
java.lang.String	getContainedExtensions() Obtains a delimited set of extensions contained within the collection.
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.
IFileNames	getSubset(java.lang.String extSet) Obtains a subset based on a delimited set of extensions.
int	hashCode() the hashcode for this object
boolean	isDirectory() Indicates if the current filename is a directory.
void	loadFromPath(java.lang.String path) Loads the collection with files from the specified path.
java.lang.String	next() Obtains the next filename in the array.
void	release() Release this COM object reference
void	remove() Removes the current filename from the array.
void	reset() Resets the current position back to the beginning of the array.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileNames

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

Constructs a FileNames using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

FileNames

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

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

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

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

add

public void add(java.lang.String fileName)
         throws java.io.IOException,
                AutomationException

Adds a filename to the array.

Specified by:

add in interface IFileNames

Parameters:

fileName - The fileName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

remove

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

Removes the current filename from the array.

Specified by:

remove in interface IFileNames

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reset

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

Resets the current position back to the beginning of the array.

Specified by:

reset in interface IFileNames

Throws:

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

AutomationException - If the ArcObject component throws an exception.

next

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

Obtains the next filename in the array.

Specified by:

next in interface IFileNames

Returns:

The fileName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirectory

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

Indicates if the current filename is a directory.

Specified by:

isDirectory in interface IFileNames

Returns:

The isDirectory

Throws:

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

AutomationException - If the ArcObject component throws an exception.

loadFromPath

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

Loads the collection with files from the specified path.

Specified by:

loadFromPath in interface IFileNames2

Parameters:

path - The path (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubset

public IFileNames getSubset(java.lang.String extSet)
                     throws java.io.IOException,
                            AutomationException

Obtains a subset based on a delimited set of extensions.

Specified by:

getSubset in interface IFileNames2

Parameters:

extSet - The extSet (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContainedExtensions

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

Obtains a delimited set of extensions contained within the collection.

Specified by:

getContainedExtensions in interface IFileNames2

Returns:

The extSet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

find

public boolean find(java.lang.String fileName)
             throws java.io.IOException,
                    AutomationException

Advances the current postion to the specified file if it exists.

Specified by:

find in interface IFileNames2

Parameters:

fileName - The fileName (in)

Returns:

The pFound

Throws:

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

AutomationException - If the ArcObject component throws an exception.