com.mindoo.domino.jna.internal.structs.NotesCollectionDataStruct Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-jna Show documentation
Java project to access the HCL Domino C API using Java Native Access (JNA)
There is a newer version: 0.9.53
package com.mindoo.domino.jna.internal.structs;

import com.mindoo.domino.jna.internal.NotesConstants;
import com.sun.jna.Pointer;
import com.sun.jna.Structure;

import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.Arrays;
import java.util.List;

/**
 * JNA class for the COLLECTIONDATA type
 * 
 * @author Karsten Lehmann
 */
public class NotesCollectionDataStruct extends BaseStructure {

	/** Total number of documents in the collection */
	public int docCount;
	/** Total number of bytes occupied by the document entries in the collection */
	public int docTotalSize;
	/** Number of B-Tree leaf nodes for this index. */
	public int btreeLeafNodes;
	/** Number of B-tree levels for this index. */
	public short btreeDepth;
	/** Unused */
	public short spare;

	/**
	 * Offset of ITEM_VALUE_TABLE

	 * for each 10th-percentile key value.

	 * A series of ITEM_VALUE_TABLEs follows

	 * this structure.

	 * C type : DWORD[PERCENTILE_COUNT]
	 */
	public int[] keyOffset = new int[NotesConstants.PERCENTILE_COUNT];

	/**
	 * @deprecated only public to be used by JNA; use static newInstance method instead to run in AccessController.doPrivileged block
	 */
	public NotesCollectionDataStruct() {
		super();
	}

	public static NotesCollectionDataStruct newInstance() {
		return AccessController.doPrivileged(new PrivilegedAction() {

			@Override
			public NotesCollectionDataStruct run() {
				return new NotesCollectionDataStruct();
			}
		});
	}

	protected List getFieldOrder() {
		return Arrays.asList("docCount", "docTotalSize", "btreeLeafNodes", "btreeDepth", "spare", "keyOffset");
	}

	/**
	 * @param DocCount Total number of documents in the

	 * collection

	 * @param DocTotalSize Total number of bytes occupied by the

	 * document entries in the collection

	 * @param BTreeLeafNodes Number of B-Tree leaf nodes for this

	 * index.

	 * @param BTreeDepth Number of B-tree levels for this index.

	 * @param Spare Unused

	 * @param KeyOffset Offset of ITEM_VALUE_TABLE

	 * for each 10th-percentile key value.

	 * A series of ITEM_VALUE_TABLEs follows

	 * this structure.

	 * C type : DWORD[PERCENTILE_COUNT]
	 */
	public NotesCollectionDataStruct(int DocCount, int DocTotalSize, int BTreeLeafNodes, short BTreeDepth, short Spare, int[] KeyOffset) {
		super();
		this.docCount = DocCount;
		this.docTotalSize = DocTotalSize;
		this.btreeLeafNodes = BTreeLeafNodes;
		this.btreeDepth = BTreeDepth;
		this.spare = Spare;
		if ((KeyOffset.length != this.keyOffset.length)) 
			throw new IllegalArgumentException("Wrong array size !");
		this.keyOffset = KeyOffset;
	}

	public static NotesCollectionDataStruct newInstance(final int docCount, final int docTotalSize, final int btreeLeafNodes,
			final short btreeDepth, final short spare, final int[] keyOffset) {
		return AccessController.doPrivileged(new PrivilegedAction() {

			@Override
			public NotesCollectionDataStruct run() {
				return new NotesCollectionDataStruct(docCount, docTotalSize, btreeLeafNodes, btreeDepth, spare, keyOffset);
			}
		});
	}

	public NotesCollectionDataStruct(Pointer peer) {
		super(peer);
	}

	public static NotesCollectionDataStruct newInstance(final Pointer p) {
		return AccessController.doPrivileged(new PrivilegedAction() {

			@Override
			public NotesCollectionDataStruct run() {
				return new NotesCollectionDataStruct(p);
			}
		});
	}

	public static class ByReference extends NotesCollectionDataStruct implements Structure.ByReference {

	};

	public static class ByValue extends NotesCollectionDataStruct implements Structure.ByValue {

	};
}