Skip to content

Expose BlockState string representation #2425

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

Merged
dualspiral merged 2 commits into from
Apr 28, 2022
Merged

Expose BlockState string representation #2425

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7bd2c67
Expose BlockState string representation
Yeregorix Apr 23, 2022
3f8df00
Clarify BlockState#asString javadoc
Yeregorix Apr 24, 2022
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
8 changes: 8 additions & 0 deletions src/main/java/org/spongepowered/api/block/BlockState.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,14 @@ default BlockState mirror(final Supplier<? extends Mirror> mirror) {
return this.mirror(mirror.get());
}

/**
* Gets a string representation of this block state, including the block type and the properties.
Copy link
Member

@Zidane Zidane Apr 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add a further note to not confuse this with an Object's traditional toString and to use the toString to the specific implementation's descriptor of this Object.

Something like that.

* Do not confuse with {@link #toString} which is implementation specific.
*
* @return A string representation of this block state.
*/
String asString();

/**
* An {@link org.spongepowered.api.data.DataHolderBuilder.Immutable} for a {@link BlockState}. Just like the
* {@link org.spongepowered.api.data.DataHolderBuilder.Immutable}, the {@link Value}s passed in to
Expand Down