Java Pattern: Use Atomic Boolean to Return Single Usage Object

  • Time：2020-09-07 13:13:13
  • Class：Weblog
  • Read：23

Sometimes, you want the data to be accessed only once. For example, when the HTTP data stream is open for reading, once completed, you don’t want to expose the data again. This is to reduce the risks of leaking data.

It turns out we can easily use the following Design Pattern to achieve this – with the help of the Atomic Boolean types in Java. The Atomic data types are thread safe in Java – allowing multiple threads to access and modifying.

We will have a AtomicBoolean field e.g. pending to indicate whether the data is available for access. Once it has been retrieved, we set it to false via compareAndSet.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

package com.helloacm;
 
import java.util.concurrent.atomic.AtomicBoolean;
 
public class Example {
    // is the data available?
    private final AtomicBoolean pending = new AtomicBoolean(true);
 
    // data field
    private final Object data = new Object();
 
    public Object get() {
        // when it is true, return the data and set to false
        if (pending.compareAndSet(true, false)) {
            return data;
        }
        return null;
    }
}
package com.helloacm;

import java.util.concurrent.atomic.AtomicBoolean;

public class Example {
    // is the data available?
    private final AtomicBoolean pending = new AtomicBoolean(true);

    // data field
    private final Object data = new Object();

    public Object get() {
        // when it is true, return the data and set to false
        if (pending.compareAndSet(true, false)) {
            return data;
        }
        return null;
    }
}

Let’s unit test the above pattern:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

package com.helloacm;
 
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
 
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
 
public class ExampleTest {
    // test instance
    private Example instance;
 
    @BeforeEach
    public void setup() {
        instance = new Example();
    }
 
    @Test
    public void test_get_twice_should_return_null() {
        assertNotNull(instance.get());
        assertNull(instance.get());
    }
}
package com.helloacm;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;

public class ExampleTest {
    // test instance
    private Example instance;

    @BeforeEach
    public void setup() {
        instance = new Example();
    }

    @Test
    public void test_get_twice_should_return_null() {
        assertNotNull(instance.get());
        assertNull(instance.get());
    }
}

The first time, the data should be available for retrieval, then once it is invoked, the get() will return NULL. This allows data to be only accessed once.

–EOF (The Ultimate Computing & Technology Blog) —

Recommend：
How to Clone an Array in Javascript?
The Concurrent Programming Language: Cind
How to Design a Design Bounded Blocking Queue in Python using Th
The Unique Permutations Algorithm with Duplicate Elements
Python Coding Reference: index() and find() for string (substrin
Walking Robot Simulation Algorithm with Obstacles Detection
The Selection Sorting Algorithm in VBScript
Find the Queens That Can Attack the King
4 Bloggers Who Were Killed Because Of Their Content
Top Mobile Technology Trends for Bloggers
Share：Facebook Twitter
Comment list
Comment add