io.jhdf.object.message.LinkInfoMessage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jhdf Show documentation
A pure Java HDF5 library
There is a newer version: 0.9.4
/*
 * This file is part of jHDF. A pure Java library for accessing HDF5 files.
 *
 * https://jhdf.io
 *
 * Copyright (c) 2025 James Mudd
 *
 * MIT License see 'LICENSE' file
 */
package io.jhdf.object.message;

import io.jhdf.BufferBuilder;
import io.jhdf.Constants;
import io.jhdf.Superblock;
import io.jhdf.Utils;

import java.nio.ByteBuffer;
import java.util.BitSet;

public class LinkInfoMessage extends Message {

	public static final int MESSAGE_TYPE = 2;

	private static final int CREATION_ORDER_TRACKED = 0;
	private static final int CREATION_ORDER_INDEXED = 1;

	private final byte version;
	private final long maximumCreationIndex;
	private final long fractalHeapAddress;
	private final long bTreeNameIndexAddress;
	private final long bTreeCreationOrderIndexAddress;
	private final BitSet flags;

	/* package */ LinkInfoMessage(ByteBuffer bb, Superblock sb, BitSet messageFlags) {
		super(messageFlags);

		version = bb.get();
		flags = BitSet.valueOf(new byte[]{bb.get()});

		if (flags.get(CREATION_ORDER_TRACKED)) {
			maximumCreationIndex = Utils.readBytesAsUnsignedLong(bb, 8);
		} else {
			maximumCreationIndex = -1;
		}

		fractalHeapAddress = Utils.readBytesAsUnsignedLong(bb, sb.getSizeOfOffsets());

		bTreeNameIndexAddress = Utils.readBytesAsUnsignedLong(bb, sb.getSizeOfOffsets());

		if (flags.get(CREATION_ORDER_INDEXED)) {
			bTreeCreationOrderIndexAddress = Utils.readBytesAsUnsignedLong(bb, sb.getSizeOfOffsets());
		} else {
			bTreeCreationOrderIndexAddress = -1;
		}
	}

	public int getVersion() {
		return version;
	}

	public long getMaximumCreationIndex() {
		return maximumCreationIndex;
	}

	public long getFractalHeapAddress() {
		return fractalHeapAddress;
	}

	public long getBTreeNameIndexAddress() {
		return bTreeNameIndexAddress;
	}

	public long getBTreeCreationOrderIndexAddress() {
		return bTreeCreationOrderIndexAddress;
	}

	public boolean isLinkCreationOrderTracked() {
		return flags.get(CREATION_ORDER_TRACKED);
	}

	@Override
	public int getMessageType() {
		return MESSAGE_TYPE;
	}

	@Override
	public ByteBuffer toBuffer() {
		BufferBuilder bufferBuilder = new BufferBuilder()
			.writeByte(version)
			.writeBitSet(flags, 1);

		if(flags.get(CREATION_ORDER_TRACKED)) {
			bufferBuilder.writeLong(maximumCreationIndex);
		}

		bufferBuilder.writeLong(fractalHeapAddress)
			.writeLong(bTreeNameIndexAddress);

		if(flags.get(CREATION_ORDER_INDEXED)) {
			bufferBuilder.writeLong(bTreeCreationOrderIndexAddress);
		}
		return bufferBuilder.build();
	}

	private LinkInfoMessage() {
		super(new BitSet(1));
		this.flags = new BitSet(1);
		this.version  = 0;
		this.maximumCreationIndex = Constants.UNDEFINED_ADDRESS;
		this.fractalHeapAddress = Constants.UNDEFINED_ADDRESS;
		this.bTreeNameIndexAddress = Constants.UNDEFINED_ADDRESS;
		this.bTreeCreationOrderIndexAddress = Constants.UNDEFINED_ADDRESS;
	}

	public static LinkInfoMessage createBasic() {
		return new LinkInfoMessage();
	}
}