com.hcl.domino.jna.internal.structs.NotesFileObjectStruct Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-jnx-jna-r14 Show documentation
There is a newer version: 1.44.0
/*
 * ==========================================================================
 * Copyright (C) 2019-2022 HCL America, Inc. ( http://www.hcl.com/ )
 *                            All rights reserved.
 * ==========================================================================
 * 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 .
 *
 * 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 com.hcl.domino.jna.internal.structs;

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

import com.sun.jna.Pointer;
import com.sun.jna.Structure;

/**
 * This file was autogenerated by JNAerator,

 * a tool written by Olivier Chafik that uses a few opensource projects..

 * For help, please visit NativeLibs4Java , Rococoa, or JNA.
 */
public class NotesFileObjectStruct extends BaseStructure {
	/**
	 * object header

	 * C type : OBJECT_DESCRIPTOR
	 */
	public NotesObjectDescriptorStruct Header;
	/** length of file name */
	public short FileNameLength;
	/** text delimiters (HOST_xxx) */
	public short HostType;
	/** compression used (COMPRESS_xxx) */
	public short CompressionType;
	/** orig. file attribs (ATTRIB_xxx) */
	public short FileAttributes;
	/** misc. flags (FILEFLAG_xxx) */
	public short Flags;
	/** orig. file size */
	public int FileSize;
	/**
	 * orig. file date/time of creation

	 * C type : TIMEDATE
	 */
	public NotesTimeDateStruct FileCreated;
	/**
	 * orig. file date/time of mod.

	 * C type : TIMEDATE
	 */
	public NotesTimeDateStruct FileModified;

	/**
	 * @deprecated only public to be used by JNA; use static newInstance method instead to run in AccessController.doPrivileged block
	 */
	@Deprecated
	public NotesFileObjectStruct() {
		super();
		setAlignType(Structure.ALIGN_NONE);
	}
	
	public static NotesFileObjectStruct newInstance() {
		return AccessController.doPrivileged((PrivilegedAction) () -> new NotesFileObjectStruct());
	}
	
	@Override
	protected List getFieldOrder() {
		return Arrays.asList(
			"Header", //$NON-NLS-1$
			"FileNameLength", //$NON-NLS-1$
			"HostType", //$NON-NLS-1$
			"CompressionType", //$NON-NLS-1$
			"FileAttributes", //$NON-NLS-1$
			"Flags", //$NON-NLS-1$
			"FileSize", //$NON-NLS-1$
			"FileCreated", //$NON-NLS-1$
			"FileModified" //$NON-NLS-1$
		);
	}
	
	/**
	 * @param Header object header

	 * C type : OBJECT_DESCRIPTOR

	 * @param FileNameLength length of file name

	 * @param HostType text delimiters (HOST_xxx)

	 * @param CompressionType compression used (COMPRESS_xxx)

	 * @param FileAttributes orig. file attribs (ATTRIB_xxx)

	 * @param Flags misc. flags (FILEFLAG_xxx)

	 * @param FileSize orig. file size

	 * @param FileCreated orig. file date/time of creation

	 * C type : TIMEDATE

	 * @param FileModified orig. file date/time of mod.

	 * C type : TIMEDATE
	 * @deprecated only public to be used by JNA; use static newInstance method instead to run in AccessController.doPrivileged block
	 */
	@Deprecated
	public NotesFileObjectStruct(NotesObjectDescriptorStruct Header, short FileNameLength, short HostType, short CompressionType, short FileAttributes, short Flags, int FileSize, NotesTimeDateStruct FileCreated, NotesTimeDateStruct FileModified) {
		super();
		setAlignType(Structure.ALIGN_NONE);
		this.Header = Header;
		this.FileNameLength = FileNameLength;
		this.HostType = HostType;
		this.CompressionType = CompressionType;
		this.FileAttributes = FileAttributes;
		this.Flags = Flags;
		this.FileSize = FileSize;
		this.FileCreated = FileCreated;
		this.FileModified = FileModified;
	}

	public static NotesFileObjectStruct newInstance(final NotesObjectDescriptorStruct Header, final short FileNameLength, final short HostType, final short CompressionType, final short FileAttributes, final short Flags, final int FileSize, final NotesTimeDateStruct FileCreated, final NotesTimeDateStruct FileModified) {
		return AccessController.doPrivileged((PrivilegedAction) () -> new NotesFileObjectStruct(Header, FileNameLength, HostType, CompressionType, FileAttributes, Flags, FileSize, FileCreated, FileModified));
	}

	/**
	 * @deprecated only public to be used by JNA; use static newInstance method instead to run in AccessController.doPrivileged block
	 * 
	 * @param peer pointer
	 */
	@Deprecated
	public NotesFileObjectStruct(Pointer peer) {
		super(peer);
		setAlignType(Structure.ALIGN_NONE);
	}
	
	public static NotesFileObjectStruct newInstance(final Pointer peer) {
		return AccessController.doPrivileged((PrivilegedAction) () -> new NotesFileObjectStruct(peer));
	}
	
	public static class ByReference extends NotesFileObjectStruct implements Structure.ByReference {

	};
	
	public static class ByValue extends NotesFileObjectStruct implements Structure.ByValue {

	};
}