com.mindoo.domino.jna.internal.structs.NotesScheduleListStruct 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 java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.Arrays;
import java.util.List;

import com.mindoo.domino.jna.IAdaptable;
import com.sun.jna.Pointer;
import com.sun.jna.Structure;

/**
 * This is the schedule data. The {@link NotesScheduleListStruct} is followed by
 * NumEntries of {@link NotesSchedEntryStruct} or {@link NotesSchedEntryExtStruct}.
 * 
 * @author Karsten Lehmann
 */
public class NotesScheduleListStruct extends BaseStructure implements IAdaptable {
	/** Total number of schedule entries follow */
	public int NumEntries;
	/** Application id for UserAttr interpretation */
	public short wApplicationID;
	/**
	 * Pre Notes/Domino 6: spare 

	 * Notes/Domino 6: This now conveys the length of a single

	 * SCHED_ENTRY_xxx that follows.  Use this value

	 * to skip entries that MAY be larger (ie: a later version may

	 * extend SCHED_ENTRY_EXT by appending values

	 * that Notes/Domino 6 does not know about so SCHED_ENTRY_xxx

	 * would actually be larger than the Notes/Domino 6

	 * SCHED_ENTRY_EXT
	 */
	public short Spare;
	
	/**
	 * @deprecated only public to be used by JNA; use static newInstance method instead to run in AccessController.doPrivileged block
	 */
	public NotesScheduleListStruct() {
		super();
	}
	
	public static NotesScheduleListStruct newInstance() {
		return AccessController.doPrivileged(new PrivilegedAction() {

			@Override
			public NotesScheduleListStruct run() {
				return new NotesScheduleListStruct();
			}
		});
	}
	
	protected List getFieldOrder() {
		return Arrays.asList("NumEntries", "wApplicationID", "Spare");
	}
	
	/**
	 * @param NumEntries Total number of schedule entries follow

	 * @param wApplicationID Application id for UserAttr interpretation

	 * @param Spare Pre Notes/Domino 6: spare 

	 * Notes/Domino 6: This now conveys the length of a single

	 * SCHED_ENTRY_xxx that follows.  Use this value

	 * to skip entries that MAY be larger (ie: a later version may

	 * extend SCHED_ENTRY_EXT by appending values

	 * that Notes/Domino 6 does not know about so SCHED_ENTRY_xxx

	 * would actually be larger than the Notes/Domino 6

	 * SCHED_ENTRY_EXT
	 * 
	 * @deprecated only public to be used by JNA; use static newInstance method instead to run in AccessController.doPrivileged block
	 */
	public NotesScheduleListStruct(int NumEntries, short wApplicationID, short Spare) {
		super();
		this.NumEntries = NumEntries;
		this.wApplicationID = wApplicationID;
		this.Spare = Spare;
	}
	
	public static NotesScheduleListStruct newInstance(final int numEntries, final short wApplicationID, final short spare) {
		return AccessController.doPrivileged(new PrivilegedAction() {

			@Override
			public NotesScheduleListStruct run() {
				return new NotesScheduleListStruct(numEntries, wApplicationID, spare);
			}
		});
	}
	
	public NotesScheduleListStruct(Pointer peer) {
		super(peer);
	}
	
	public static NotesScheduleListStruct newInstance(final Pointer peer) {
		return AccessController.doPrivileged(new PrivilegedAction() {

			@Override
			public NotesScheduleListStruct run() {
				return new NotesScheduleListStruct(peer);
			}
		});
	}
	
	public static class ByReference extends NotesScheduleListStruct implements Structure.ByReference {
		
	};
	public static class ByValue extends NotesScheduleListStruct implements Structure.ByValue {
		
	};
	
	@Override
	public  T getAdapter(Class clazz) {
		if (clazz == NotesScheduleListStruct.class) {
			return (T) this;
		}
		else if (clazz == Pointer.class) {
			return (T) getPointer();
		}
		return null;
	}

}