net.openhft.chronicle.wire.WrappedDocumentContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of chronicle-wire Show documentation
Chronicle-Wire
The newest version!
/*
 * Copyright 2016-2020 chronicle.software
 *
 *       https://chronicle.software
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.openhft.chronicle.wire;

import net.openhft.chronicle.core.io.IORuntimeException;
import org.jetbrains.annotations.Nullable;

/**
 * This is the WrappedDocumentContext class which implements the DocumentContext interface.
 * The purpose of this class is to wrap another DocumentContext and delegate the behavior to the wrapped instance.
 * This can be used as a base for any specialized versions of DocumentContext which need to extend the default behavior.
 */
public abstract class WrappedDocumentContext implements DocumentContext {

    // The wrapped instance of DocumentContext.
    private DocumentContext dc;

    /**
     * Constructs a new instance of WrappedDocumentContext that wraps the provided DocumentContext.
     *
     * @param dc The DocumentContext to be wrapped.
     */
    protected WrappedDocumentContext(DocumentContext dc) {
        this.dc = dc;
    }

    /**
     * Getter method to retrieve the wrapped DocumentContext instance.
     *
     * @return The wrapped DocumentContext instance.
     */
    public DocumentContext dc() {
        return dc;
    }

    /**
     * Setter method to update the wrapped DocumentContext instance.
     * This method is designed to follow the builder pattern, returning the current instance for chained calls.
     *
     * @param dc The new DocumentContext instance to be wrapped.
     * @return The current instance of WrappedDocumentContext.
     */
    public WrappedDocumentContext dc(DocumentContext dc) {
        this.dc = dc;
        return this;
    }

    @Override
    public boolean isMetaData() {
        return dc.isMetaData();
    }

    @Override
    public boolean isPresent() {
        return dc.isPresent();
    }

    @Nullable
    @Override
    public Wire wire() {
        return dc.wire();
    }

    @Override
    public boolean isNotComplete() {
        return dc.isNotComplete();
    }

    @Override
    public void close() {
        dc.close();
    }

    @Override
    public int sourceId() {
        return dc.sourceId();
    }

    @Override
    public long index() throws IORuntimeException {
        return dc.index();
    }

    @Override
    public boolean isData() {
        return dc.isData();
    }

    @Override
    public void rollbackOnClose() {
        dc.rollbackOnClose();
    }
}