Skip to content

Standardizing Formatter Documentation for Improved Usability #546

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JumpiiX wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Standardizing Formatter Documentation for Improved Usability #546

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
07ee2ca
ArrayObjectFormatter
JumpiiX Mar 30, 2024
4240b29
BooleanFormatter
JumpiiX Mar 30, 2024
2ad2638
CharacterFormatter
JumpiiX Mar 30, 2024
415f2ba
ClassObjectFormatter
JumpiiX Mar 30, 2024
8a875eb
ITypeFormatter
JumpiiX Mar 30, 2024
031363c
NullObjectFormatter
JumpiiX Mar 30, 2024
24bb8b0
NumericFormatEnum
JumpiiX Mar 30, 2024
ccc4a6c
NumericFormatter
JumpiiX Mar 30, 2024
bf53d6d
ObjectFormatter
JumpiiX Mar 30, 2024
36eb08a
SimpleTypeFormatter
JumpiiX Mar 30, 2024
61fb970
StringObjectFormatter
JumpiiX Mar 30, 2024
2548835
TypeIdentifiers
JumpiiX Mar 30, 2024
83b4c45
refactor
JumpiiX Mar 30, 2024
86c5e58
refactor
JumpiiX Mar 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
NullObjectFormatter
  • Loading branch information
@JumpiiX
JumpiiX committed Mar 30, 2024
commit 031363cb0d3309ace5263ac1347ee9007cb11de9
30 changes: 30 additions & 0 deletions ...re/src/main/java/com/microsoft/java/debug/core/adapter/formatter/NullObjectFormatter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,49 @@
import com.sun.jdi.Type;
import com.sun.jdi.Value;

/**
* A formatter dedicated to handling null values in the Java Debug Interface (JDI).
* Implements the {@link IValueFormatter} interface, providing a uniform representation
* for null objects during debugging sessions.
*/
public class NullObjectFormatter implements IValueFormatter {
public static final String NULL_STRING = "null";

/**
* Provides a string representation for null values.
*
* @param value The value to be formatted, expected to be null in this context.
* @param options Additional options affecting the format; unused in this formatter.
* @return A constant string "null" to represent null values.
*/
@Override
public String toString(Object value, Map<String, Object> options) {
return NULL_STRING;
}

/**
* Determines if this formatter is applicable for the given type,
* specifically targeting null types.
*
* @param type The JDI type of the object, expected to be null.
* @param options Additional options that might influence the decision; unused in this formatter.
* @return True if the type is null, indicating this formatter should be used.
*/
@Override
public boolean acceptType(Type type, Map<String, Object> options) {
return type == null;
}

/**
* Converts a string representation of null into a JDI Value object, which is also null.
* Throws {@link UnsupportedOperationException} if a non-null value is attempted to be set.
*
* @param value The string value to convert, expected to match "null".
* @param type The expected JDI type; unused in this formatter as the output is always null.
* @param options Additional conversion options; unused in this formatter.
* @return null, as the only supported conversion is from the string "null" to a null {@link Value}.
* @throws UnsupportedOperationException if set value is attempted with a non-null value.
*/
@Override
public Value valueOf(String value, Type type, Map<String, Object> options) {
if (value == null || NULL_STRING.equals(value)) {
Expand Down