net.sf.okapi.common.resource

Interface IReferenceable

All Known Subinterfaces:

ITextUnit

All Known Implementing Classes:

BaseReferenceable, DocumentPart, StartGroup, StartSubfilter, StorageList, TextUnit

public interface IReferenceable

Interface for all resources that can be passed as referents through the filter events.

Method Summary

Modifier and Type	Method and Description
int	getReferenceCount() Gets the number of time this referent is referenced to.
boolean	isReferent() Indicates if this resource is a referent (i.e.
void	setIsReferent(boolean value) Sets the flag indicating if this resource is a referent (i.e.
void	setReferenceCount(int value) Sets the number of time this referent is referenced to.

Method Detail

setIsReferent

void setIsReferent(boolean value)

Sets the flag indicating if this resource is a referent (i.e. is referred to by another resource) or not. This also sets the count of time this referent is referenced to 1.

Parameters:

value - true if the resource is a referent, false if it is not.

isReferent

boolean isReferent()

Indicates if this resource is a referent (i.e. is referred to by another resource) or not.

Returns:

true if this resource is a referent, false if it is not.

getReferenceCount

int getReferenceCount()

Gets the number of time this referent is referenced to.

Returns:

the number of time this referent is referenced to.

setReferenceCount

void setReferenceCount(int value)

Sets the number of time this referent is referenced to.

Parameters:

value - the number of time this referent is referenced to.