Package org.apache.jackrabbit.oak.segment

Class Compactor

java.lang.Object

org.apache.jackrabbit.oak.segment.Compactor

Direct Known Subclasses:

CheckpointCompactor, ClassicCompactor

public abstract class Compactor
extends Object

Constructor Summary

Constructors

Constructor	Description
Compactor()

Method Summary

Modifier and Type	Method	Description
abstract @Nullable CompactedNodeState	compact(@NotNull NodeState before, @NotNull NodeState after, @NotNull NodeState onto, @NotNull Canceller canceller)	compact the differences between after and before on top of onto.
@Nullable CompactedNodeState	compactDown(@NotNull NodeState state, @NotNull Canceller hardCanceller, @NotNull Canceller softCanceller)
abstract @Nullable CompactedNodeState	compactDown(@NotNull NodeState before, @NotNull NodeState after, @NotNull Canceller hardCanceller, @NotNull Canceller softCanceller)	compact the differences between after and before on top of after.
@Nullable CompactedNodeState	compactUp(@NotNull NodeState state, @NotNull Canceller canceller)
@Nullable CompactedNodeState	compactUp(@NotNull NodeState before, @NotNull NodeState after, @NotNull Canceller canceller)	compact the differences between after and before on top of before.

Methods inherited from class java.lang.Object

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

Constructor Detail

Compactor

public Compactor()

Method Detail

compactDown

@Nullable
public final @Nullable CompactedNodeState compactDown(@NotNull
                                                      @NotNull NodeState state,
                                                      @NotNull
                                                      @NotNull Canceller hardCanceller,
                                                      @NotNull
                                                      @NotNull Canceller softCanceller)
                                               throws IOException

Throws:

IOException

compactDown

@Nullable
public abstract @Nullable CompactedNodeState compactDown(@NotNull
                                                         @NotNull NodeState before,
                                                         @NotNull
                                                         @NotNull NodeState after,
                                                         @NotNull
                                                         @NotNull Canceller hardCanceller,
                                                         @NotNull
                                                         @NotNull Canceller softCanceller)
                                                  throws IOException

compact the differences between after and before on top of after.

Parameters:

before - the node state to diff against from after

after - the node state diffed against before

hardCanceller - the trigger for hard cancellation, will abandon compaction if cancelled

softCanceller - the trigger for soft cancellation, will return partially compacted state if cancelled

Returns:

the compacted node state or null if hard-cancelled

Throws:

IOException - will throw exception if any errors occur during compaction

compactUp

@Nullable
public final @Nullable CompactedNodeState compactUp(@NotNull
                                                    @NotNull NodeState state,
                                                    @NotNull
                                                    @NotNull Canceller canceller)
                                             throws IOException

Throws:

IOException

compactUp

@Nullable
public final @Nullable CompactedNodeState compactUp(@NotNull
                                                    @NotNull NodeState before,
                                                    @NotNull
                                                    @NotNull NodeState after,
                                                    @NotNull
                                                    @NotNull Canceller canceller)
                                             throws IOException

compact the differences between after and before on top of before.

Throws:

IOException

compact

@Nullable
public abstract @Nullable CompactedNodeState compact(@NotNull
                                                     @NotNull NodeState before,
                                                     @NotNull
                                                     @NotNull NodeState after,
                                                     @NotNull
                                                     @NotNull NodeState onto,
                                                     @NotNull
                                                     @NotNull Canceller canceller)
                                              throws IOException

compact the differences between after and before on top of onto.

Parameters:

before - the node state to diff against from after

after - the node state diffed against before

onto - the node state to compact to apply the diff to

canceller - the trigger for hard cancellation, will abandon compaction if cancelled

Returns:

the compacted node state or null if hard-cancelled

Throws:

IOException - will throw exception if any errors occur during compaction