Package de.linusdev.lutils.struct.mod

Class ModTrackingStructure

java.lang.Object

de.linusdev.lutils.struct.abstracts.Structure

de.linusdev.lutils.struct.mod.ModTrackingStructure

All Implemented Interfaces:

MemorySizeable, NativeParsable

Direct Known Subclasses:

ComplexStructure, StructureArray

public abstract class ModTrackingStructure
extends Structure

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModTrackingStructure.ModificationsHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected ReentrantLock	modificationLock
protected final int	modificationSplitOffset
protected ModificationInfo	modInfo
protected final boolean	trackModifications

Fields inherited from class de.linusdev.lutils.struct.abstracts.Structure

byteBuf, modified, mostParentStructure, offset

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ModTrackingStructure(boolean trackModifications)

Method Summary

Modifier and Type	Method	Description
protected void	claimBuffer(@NotNull ByteBuffer buffer)	Will set the ByteOrder to native order.
@Nullable ModificationInfo	getFirstModificationInfo(boolean clear)	Get the first ModificationInfo.
boolean	handleModifications(@NotNull ModTrackingStructure.ModificationsHandler handler)	Calls ModTrackingStructure.ModificationsHandler.handle(ModificationInfo) for each ModificationInfo.
protected void	onModification(int offset, int size)	Called on the most parental structure if on it or any of its children Structure.modified(int, int) is called.
boolean	tracksModifications()	Whether this structure tracks modifications using ModificationInfo.
protected void	useBuffer(@NotNull Structure mostParentStructure, int offset)	Set this Structure to be a child of mostParentStructure.

Methods inherited from class de.linusdev.lutils.struct.abstracts.Structure

allocate, callUseBufferOf, generateStructCode, getAlignment, getByteBuffer, getInfo, getMostParentStructure, getOffset, getRequiredSize, isInitialised, isModified, modified, modified, toString, unmodified

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.linusdev.lutils.struct.abstracts.NativeParsable

getPointer

Field Details

trackModifications

protected final boolean trackModifications

modificationLock

protected ReentrantLock modificationLock

modificationSplitOffset

protected final int modificationSplitOffset

See Also:

• Constant Field Values

modInfo

protected ModificationInfo modInfo

Constructor Details

ModTrackingStructure

protected ModTrackingStructure(boolean trackModifications)

Method Details

useBuffer

protected void useBuffer(@NotNull
 @NotNull Structure mostParentStructure,
 int offset)

Description copied from class: Structure

Set this Structure to be a child of mostParentStructure.

Overrides:

useBuffer in class Structure

Parameters:

mostParentStructure - most parental structure

offset - start of this structure

claimBuffer

protected void claimBuffer(@NotNull
 @NotNull ByteBuffer buffer)

Description copied from class: Structure

Will set the ByteOrder to native order. The most parental structure will be this.

Overrides:

claimBuffer in class Structure

Parameters:

buffer - ByteBuffer to claim

onModification

protected void onModification(int offset,
 int size)

Description copied from class: Structure

Called on the most parental structure if on it or any of its children Structure.modified(int, int) is called.

Overrides:

onModification in class Structure

Parameters:

offset - modified region start

size - modified region size

getFirstModificationInfo

@Internal
@Nullable
public @Nullable ModificationInfo getFirstModificationInfo(boolean clear)

Get the first ModificationInfo. Only available if this structure was modified and tracks modifications.

Parameters:

clear - true if the modifications should be cleared.

Returns:

ModificationInfo or null

tracksModifications

public boolean tracksModifications()

Whether this structure tracks modifications using ModificationInfo.

handleModifications

public boolean handleModifications(@NotNull
 @NotNull ModTrackingStructure.ModificationsHandler handler)

Calls ModTrackingStructure.ModificationsHandler.handle(ModificationInfo) for each ModificationInfo. If this structure was not modified, false will be returned.

Parameters:

handler - ModTrackingStructure.ModificationsHandler

Returns:

true if this structure was modified.