com.hcl.domino.jna.internal.gc.handles.DHANDLE64 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
The newest version!
/*
 * ==========================================================================
 * 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.gc.handles;

import java.security.AccessController;
import java.security.PrivilegedAction;
import java.text.MessageFormat;
import java.util.Arrays;
import java.util.List;
import java.util.concurrent.locks.Lock;

import com.hcl.domino.jna.internal.structs.BaseStructure;
import com.hcl.domino.jna.internal.gc.JNAGCUtil;
import com.sun.jna.Pointer;
import com.sun.jna.Structure;

/**
 * DHANDLE on 64 bit systems
 * 
 * @author Karsten Lehmann
 */
public class DHANDLE64 extends BaseStructure implements DHANDLE {
	public long hdl;
	private boolean disposed;
	
	/**
	 * @deprecated only public to be used by JNA; use static newInstance method instead to run in AccessController.doPrivileged block
	 */
	@Deprecated
	public DHANDLE64() {
		super();
		//set ALIGN to NONE, because the NAMES_LIST structure is directly followed by the usernames and wildcards in memory
		setAlignType(ALIGN_DEFAULT);
	}

	public static DHANDLE64 newInstance(long hdl) {
		return AccessController.doPrivileged((PrivilegedAction) () -> new DHANDLE64(hdl));
	}

	@Override
	public void clear() {
		hdl = 0;
	}

	@Override
	public  R _lockHandleAccess(HandleAccess handleAccess) {
		return AccessController.doPrivileged((PrivilegedAction) () -> {
			Lock lock = JNAGCUtil.getHandleLock(DHANDLE64.this);
			lock.lock();
			try {
				checkDisposed();
				
				DHANDLE64.ByValue newHdl = new DHANDLE64.ByValue();
				newHdl.hdl = DHANDLE64.this.hdl;
				return handleAccess.accessLockedHandle(newHdl);
			}
			finally {
				lock.unlock();
			}
		});
	}
	
	@Override
	public boolean isDisposed() {
		return disposed;
	}

	@Override
	public void setDisposed() {
		disposed = true;
	}
	
	@Override
	protected List getFieldOrder() {
		return Arrays.asList("hdl"); //$NON-NLS-1$
	}

	/**
	 * Creates a new instance
	 * 
	 * @param hdl handle value
	 * @deprecated only public to be used by JNA; use static newInstance method instead to run in AccessController.doPrivileged block
	 */
	@Deprecated
	public DHANDLE64(long hdl) {
		super();
		setAlignType(ALIGN_DEFAULT);
		this.hdl = hdl;
	}

	/**
	 * @deprecated only public to be used by JNA; use static newInstance method instead to run in AccessController.doPrivileged block
	 * 
	 * @param peer pointer
	 */
	@Deprecated
	public DHANDLE64(Pointer peer) {
		super(peer);
		setAlignType(ALIGN_DEFAULT);
	}

	public static DHANDLE64 newInstance(final Pointer peer) {
		return AccessController.doPrivileged((PrivilegedAction) () -> new DHANDLE64(peer));
	}

	public static class ByReference extends DHANDLE64 implements Structure.ByReference, DHANDLE.ByReference {
		/**
		 * @deprecated only public to be used by JNA; use static newInstance method instead to run in AccessController.doPrivileged block
		 */
		@Deprecated
		public ByReference() {
			super();
		}
		
		/**
		 * @param peer memory pointer
		 * @deprecated only public to be used by JNA; use static newInstance method instead to run in AccessController.doPrivileged block
		 */
		@Deprecated
		public ByReference(Pointer peer) {
			super(peer);
		}
	};
	public static class ByValue extends DHANDLE64 implements Structure.ByValue, DHANDLE.ByValue {
		/**
		 * @deprecated only public to be used by JNA; use static newInstance method instead to run in AccessController.doPrivileged block
		 */
		@Deprecated
		public ByValue() {
			super();
		}
		
		/**
		 * @param peer memory pointer
		 * @deprecated only public to be used by JNA; use static newInstance method instead to run in AccessController.doPrivileged block
		 */
		@Deprecated
		public ByValue(Pointer peer) {
			super(peer);
		}
	};
	
	@SuppressWarnings("unchecked")
	@Override
	public  T getAdapter(Class clazz) {
		if (clazz == DHANDLE.class || clazz == DHANDLE64.class) {
			return (T) this;
		}
		else if(clazz == Structure.class) {
			return (T)this;
		}
		else if(clazz == Pointer.class) {
			return (T)getPointer();
		}
		
		return null;
	}
	
	@Override
	public boolean isNull() {
		return hdl==0;
	}

	@Override
	public String toString() {
		return MessageFormat.format("DHANDLE64 [handle={0}]", hdl); //$NON-NLS-1$
	}

}