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
SimpleTypeFormatter
  • Loading branch information
@JumpiiX
JumpiiX committed Mar 30, 2024
commit 36eb08a8a10b2cb85aea78a0ed25d4bff3889712
42 changes: 33 additions & 9 deletions ...re/src/main/java/com/microsoft/java/debug/core/adapter/formatter/SimpleTypeFormatter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,22 @@

import com.sun.jdi.Type;

/**
* Implements a type formatter to provide string representations of JDI types,
* with the option to use fully qualified class names or simple names.
* It facilitates readability and customization in how types are presented during debugging.
*/
public class SimpleTypeFormatter implements ITypeFormatter {
public static final String QUALIFIED_CLASS_NAME_OPTION = "qualified_class_name";
private static final boolean DEFAULT_QUALIFIED_CLASS_NAME_OPTION = false;

/**
* Format a JDI type, using the <code>SimpleTypeFormatter.QUALIFIED_FORMAT_OPTION</code> to control whether or not
* to use the fully qualified name. Set QUALIFIED_FORMAT_OPTION to true(<code>java.lang.Boolean</code>) to enable
* fully qualified name, the default option for QUALIFIED_FORMAT_OPTION is false.
* Formats the given JDI type into a string representation.
* The format can be controlled via options to either show the fully qualified class name or just the simple name.
*
* @param type the Jdi type
* @param options the format options
* @return the type name
* @param type The JDI type to be formatted.
* @param options Formatting options that dictate whether to use the fully qualified name.
* @return The formatted string representation of the type.
*/
@Override
public String toString(Object type, Map<String, Object> options) {
Expand All @@ -39,11 +43,23 @@ public String toString(Object type, Map<String, Object> options) {
return showQualifiedClassName(options) ? typeName : trimTypeName(typeName);
}

/**
* Always accepts the provided type since it is capable of formatting any type.
*
* @param type The JDI type.
* @param options Not used in this method.
* @return Always true, indicating that any type is supported.
*/
@Override
public boolean acceptType(Type type, Map<String, Object> options) {
return true;
}

/**
* Provides the default formatting options for this formatter.
*
* @return A map containing the default options, specifying the use of simple names by default.
*/
@Override
public Map<String, Object> getDefaultOptions() {
Map<String, Object> options = new HashMap<>();
Expand All @@ -52,9 +68,11 @@ public Map<String, Object> getDefaultOptions() {
}

/**
* An utility method for convert fully qualified class name to the simplified class name.
* @param type the fully qualified class name
* @return the simplified class name
* Trims a fully qualified class name to its simple name.
* If the class name contains a dot, it returns the substring after the last dot.
*
* @param type The fully qualified class name.
* @return The simple class name without package qualification.
*/
public static String trimTypeName(String type) {
if (type.indexOf('.') >= 0) {
Expand All @@ -63,6 +81,12 @@ public static String trimTypeName(String type) {
return type;
}

/**
* Determines whether to show fully qualified class names based on the provided options.
*
* @param options The formatting options map which may contain a value for {@link #QUALIFIED_CLASS_NAME_OPTION}.
* @return True if the options specify to show fully qualified names; otherwise, false.
*/
private static boolean showQualifiedClassName(Map<String, Object> options) {
return options.containsKey(QUALIFIED_CLASS_NAME_OPTION)
? (Boolean) options.get(QUALIFIED_CLASS_NAME_OPTION) : DEFAULT_QUALIFIED_CLASS_NAME_OPTION;
Expand Down