How do I pass a primitive data type by reference?

by

There isn’t a way to pass a primitive directly by reference in Java.

A workaround is to instead pass a reference to an instance of a wrapper class, which then contains the primitive as a member field. Such a wrapper class could be extremely simple to write for yourself:

public class IntRef { public int value; }

But how about some pre-built wrapper classes, so we don’t have to write our own? OK:

The Apache commons-lang Mutable* classes:

Advantages: Good performance for single threaded use. Completeness.

Disadvantages: Introduces a third-party library dependency. No built-in concurrency controls.

Representative classes: MutableBoolean, MutableByte, MutableDouble, MutableFloat, MutableInt, MutableLong, MutableObject, MutableShort.

The java.util.concurrent.atomic Atomic* classes:
Advantages: Part of the standard Java (1.5+) API. Built-in concurrency controls.
Disadvantages: Small performance hit when used in a single-threaded setting. Missing direct support for some datatypes, e.g. there is no AtomicShort.

Representative classes: AtomicBoolean, AtomicInteger, AtomicLong, and AtomicReference.

Note: As user ColinD shows in his answer, AtomicReference can be used to approximate some of the missing classes, e.g. AtomicShort.

Length 1 primitive array
OscarRyz’s answer demonstrates using a length 1 array to “wrap” a primitive value.

Advantages: Quick to write. Performant. No 3rd party library necessary.

Disadvantages: A little dirty. No built-in concurrency controls. Results in code that does not (clearly) self-document: is the array in the method signature there so I can pass multiple values? Or is it here as scaffolding for pass-by-reference emulation?

Also see
The answers to StackOverflow question “Mutable boolean field in Java“.

My Opinion
In Java, you should strive to use the above approaches sparingly or not at all. In C it is common to use a function’s return value to relay a status code (SUCCESS/FAILURE), while a function’s actual output is relayed via one or more out-parameters. In Java, it is best to use Exceptions instead of return codes. This frees up method return values to be used for carrying the actual method output — a design pattern which most Java programmers find to be more natural than out-parameters.

More Related Contents:

  1. Is Java "pass-by-reference" or "pass-by-value"?
  2. Why is 128==128 false but 127==127 is true when comparing Integer wrappers in Java?
  3. How to convert an ArrayList containing Integers to primitive int array?
  4. Why must local variables, including primitives, always be initialized in Java?
  5. Why do people still use primitive types in Java?
  6. Why should I use the keyword “final” on a method parameter in Java?
  7. How to do the equivalent of pass by reference for primitives in Java
  8. Why can Java Collections not directly store Primitives types?
  9. When to use wrapper class and primitive type
  10. Passing a String by Reference in Java?
  11. Is a Java array of primitives stored in stack or heap?
  12. In java, is it more efficient to use byte or short instead of int and float instead of double?
  13. Converting an array of objects to an array of their primitive types
  14. How to determine the primitive type of a primitive variable?
  15. How can I pass an Integer class correctly by reference?
  16. Java : Best way to pass int by reference
  17. Is it valid to compare a double with an int in java?
  18. Setting Short Value Java
  19. Most efficient Java primitive collections library [closed]
  20. Is Java really passing objects by value? [duplicate]
  21. When to use primitive and when reference types in Java
  22. How can I simulate pass by reference in Java?
  23. Does Java pass by reference? [duplicate]
  24. Overflowing Short in java
  25. Is it possible to write swap method in Java? [duplicate]
  26. Java: Why can’t I cast int to Long
  27. Java: How to pass byte[] by reference?
  28. Casting rules for primitive types in java
  29. Java is NEVER pass-by-reference, right?…right? [duplicate]
  30. Compare two arrays of primitives in Java?

Leave a Comment