Create a VolatileNativeBooleanType

src/main/java/net/imglib2/type/volatiles/VolatileNativeBoolType.java

@@ -0,0 +1,146 @@
+/*
+ * #%L
+ * ImgLib2: a general-purpose, multidimensional image processing library.
+ * %%
+ * Copyright (C) 2009 - 2022 Tobias Pietzsch, Stephan Preibisch, Stephan Saalfeld,
+ * John Bogovic, Albert Cardona, Barry DeZonia, Christian Dietz, Jan Funke,
+ * Aivar Grislis, Jonathan Hale, Grant Harris, Stefan Helfrich, Mark Hiner,
+ * Martin Horn, Steffen Jaensch, Lee Kamentsky, Larry Lindsey, Melissa Linkert,
+ * Mark Longair, Brian Northan, Nick Perry, Curtis Rueden, Johannes Schindelin,
+ * Jean-Yves Tinevez and Michael Zinsmaier.
+ * %%
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ * #L%
+ */
+
+package net.imglib2.type.volatiles;
+
+import net.imglib2.Volatile;
+import net.imglib2.img.NativeImg;
+import net.imglib2.img.basictypeaccess.BooleanAccess;
+import net.imglib2.img.basictypeaccess.ByteAccess;
+import net.imglib2.img.basictypeaccess.volatiles.VolatileBooleanAccess;
+import net.imglib2.img.basictypeaccess.volatiles.VolatileByteAccess;
+import net.imglib2.img.basictypeaccess.volatiles.array.VolatileBooleanArray;
+import net.imglib2.img.basictypeaccess.volatiles.array.VolatileByteArray;
+import net.imglib2.type.NativeTypeFactory;
+import net.imglib2.type.logic.NativeBoolType;
+import net.imglib2.type.numeric.integer.ByteType;
+
+/**
+ * A {@link Volatile} variant of {@link NativeBoolType}. It uses an
+ * underlying {@link NativeBoolType} that maps into a
+ * {@link VolatileBooleanAccess}.
+ *
+ * @author Gabriel Selzer
+ */
+public class VolatileNativeBoolType extends
+		AbstractVolatileNativeRealType<NativeBoolType, VolatileNativeBoolType>
+{
+
+	final protected NativeImg<?, ? extends VolatileBooleanAccess> img;
+
+	private static class WrappedNativeBoolType extends NativeBoolType {
+
+		public WrappedNativeBoolType(
+				final NativeImg<?, ? extends BooleanAccess> img)
+		{
+			super(img);
+		}
+
+		public WrappedNativeBoolType(final BooleanAccess access)
+		{
+			super(access);
+		}
+
+		public void setAccess(final BooleanAccess access)
+		{
+			dataAccess = access;
+		}
+	}
+
+	// this is the constructor if you want it to read from an array
+	public VolatileNativeBoolType(
+			final NativeImg<?, ? extends VolatileBooleanAccess> img)
+	{
+		super(new WrappedNativeBoolType(img), false);
+		this.img = img;
+	}
+
+	// this is the constructor if you want to specify the dataAccess
+	public VolatileNativeBoolType(final VolatileBooleanAccess access)
+	{
+		super(new WrappedNativeBoolType(access), access.isValid());
+		this.img = null;
+	}
+
+	// this is the constructor if you want it to be a variable
+	public VolatileNativeBoolType(final boolean value)
+	{
+		this(new VolatileBooleanArray(1, true));
+		set(value);
+	}
+
+	// this is the constructor if you want it to be a variable
+	public VolatileNativeBoolType()
+	{
+		this(false);
+	}
+
+	public void set(final boolean value)
+	{
+		get().set(value);
+	}
+
+	@Override public void updateContainer(final Object c)
+	{
+		final VolatileBooleanAccess a = img.update(c);
+		((WrappedNativeBoolType) t).setAccess(a);
+		setValid(a.isValid());
+	}
+
+	@Override public VolatileNativeBoolType duplicateTypeOnSameNativeImg()
+	{
+		return new VolatileNativeBoolType(img);
+	}
+
+	@Override public VolatileNativeBoolType createVariable()
+	{
+		return new VolatileNativeBoolType();
+	}
+
+	@Override public VolatileNativeBoolType copy()
+	{
+		final VolatileNativeBoolType v = createVariable();
+		v.set(this);
+		return v;
+	}
+
+	private static final NativeTypeFactory<VolatileNativeBoolType, VolatileBooleanAccess>
+			typeFactory = NativeTypeFactory.BOOLEAN(VolatileNativeBoolType::new);
+
+	@Override
+	public NativeTypeFactory<VolatileNativeBoolType, ?> getNativeTypeFactory()
+	{
+		return typeFactory;
+	}
+}