Package de.tracetronic.jenkins.plugins.ecutest.wrapper.com

Class Cache

java.lang.Object

com.jacob.com.JacobObject

com.jacob.com.Dispatch

de.tracetronic.jenkins.plugins.ecutest.wrapper.com.ETComDispatch

de.tracetronic.jenkins.plugins.ecutest.wrapper.com.Cache

All Implemented Interfaces:

ComCache, AutoCloseable

public class Cache
extends ETComDispatch
implements ComCache

COM object giving access to a specific file cache.

Field Summary

Fields inherited from class com.jacob.com.Dispatch

fdexNameCaseSensitive, Get, LOCALE_SYSTEM_DEFAULT, m_pDispatch, Method, Put, PutRef

Constructor Summary

Constructors

Constructor	Description
Cache(com.jacob.com.Dispatch dispatch, boolean useTimeout, Caches.CacheType type)	Instantiates a new Cache.

Method Summary

Modifier and Type	Method	Description
void	clear()	Same as clear(boolean) but with default parameters.
void	clear(boolean force)	Remove all cache files of this category.
List<String>	getFiles()	Returns all cache files of this category.
Caches.CacheType	getType()
void	insert(String filePath)	Same as insert(String, String) but without database channel.
void	insert(String filePath, String dbChannel)	Insert a database to the cache.

Methods inherited from class de.tracetronic.jenkins.plugins.ecutest.wrapper.com.ETComDispatch

close, finalize, isAttached, performDirectRequest, performDirectRequest, performRequest, performRequest, performRequest, performRequest, useTimeout

Methods inherited from class com.jacob.com.Dispatch

call, call, call, call, callN, callN, callN_CaseSensitive, callSub, callSub, callSub, callSub, callSubN, callSubN, coCreateInstance, get, get, get_CaseSensitive, getActiveInstance, getIDOfName, getIDsOfNames, getIDsOfNames, getProgramId, hasExited, hasExited, invoke, invoke, invoke, invokeSub, invokeSub, invokeSub, invokeSubv, invokeSubv, invokeSubv, invokev, invokev, invokev, invokev, put, put, put_Casesensitive, putRef, putRef, QueryInterface, safeRelease

Methods inherited from class com.jacob.com.JacobObject

debug, getBuildDate, getBuildVersion, isDebugEnabled

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Cache

public Cache(com.jacob.com.Dispatch dispatch,
             boolean useTimeout,
             Caches.CacheType type)

Instantiates a new Cache.

This constructor is used instead of a case operation to turn a Dispatch object into a wider object - it must exist in every wrapper class whose instances may be returned from method calls wrapped in VT_DISPATCH Variants.

Parameters:

dispatch - the dispatch

useTimeout - specifies whether to apply timeout

type - the cache type

Method Detail

getType

public Caches.CacheType getType()

insert

public void insert(String filePath)
            throws ETComException

Same as insert(String, String) but without database channel.

Parameters:

filePath - the file path of the database to be added to the cache

Throws:

ETComException - in case of a COM exception

See Also:

insert(String, String)

insert

public void insert(String filePath,
                   String dbChannel)
            throws ETComException

Description copied from interface: ComCache

Insert a database to the cache.

Specified by:

insert in interface ComCache

Parameters:

filePath - the file path of the database to be added to the cache

dbChannel - the optional database channel. Only needed by bus and service databases.

Throws:

ETComException - in case of a COM exception

clear

public void clear()
           throws ETComException

Same as clear(boolean) but with default parameters.

Throws:

ETComException - in case of a COM exception

See Also:

clear(boolean)

clear

public void clear(boolean force)
           throws ETComException

Description copied from interface: ComCache

Remove all cache files of this category.

Specified by:

clear in interface ComCache

Parameters:

force - specifies wether to close already opend cache files

Throws:

ETComException - in case of a COM exception

getFiles

public List<String> getFiles()
                      throws ETComException

Description copied from interface: ComCache

Returns all cache files of this category.

Specified by:

getFiles in interface ComCache

Returns:

the list of available cache files

Throws:

ETComException - in case of a COM exception