Add player object

[TheNullicorn]

• Provides weak encapsulation around player response JSON in the form of the Player object

  • Comes with methods for common operations, like getting the player's name, rank, experience, etc
  • Inherits from UnstableHypixelObject, which itself wraps the actual response JSON
    • Getters accept a simplified version of JsonPath (dot-notation; supports escaping)
    • Provides a layer of null-safety when accessing deeply-nested properties (whose parents may be null)
    • The original object can still be retrieved via getRaw()

• Adds an optional API for filtering unwanted/unneeded properties from objects (based on MongoDB projections)

  • Wanted keys can be marked for inclusion via PropertyFilter#include(String[]) and the static constructor PropertyFilter#including(String[])
  • Filtered objects will only contain those properties whose names are explicitly included
  • All UnstableHypixelObject support filtering via their filter(PropertyFilter) method
  • Filtered overloads for all player getters are added to HypixelAPI
    • e.g. HypixelAPI#getPlayerByUuid(UUID, PropertyFilter)

• Updates GetPlayerExample to reflect these changes

[mdashlw]

Not sure if it ends up being merged, but it definitely answers some basic questions and ambiguities around stuff, such as networkLevel field.

[TheNullicorn]

Just gonna make this a draft until I'm sure it's good. Are there any other methods you think would be helpful on a player object? Also, thoughts on getUuid returning a java.util.UUID instead of a string?

[HydroPage]

I was wondering if this was being done. That's a LOT of work for you, man, good luck (I'm a little under the impression that you're going to map most if not all of the Player JsonObject? Probably overkill)

[TheNullicorn]

I was wondering if this was being done. That's a LOT of work for you, man, good luck (I'm a little under the impression that you're going to map most if not all of the Player JsonObject? Probably overkill)

Sorry to disappoint, but that wasn't my plan for the PR. This is mainly for providing a layer of null-safety over the player structure, making it easier to access deeply nested fields which could potentially be missing. Player objects have no defined structure and are constantly changing, so mapping out the entire thing would be unrealistic. I did provided some utility methods for common fields though, such as those related to rank, experience, etc.

[ConnorLinfoot]

Just some minor changes that I can also change once this is merged if needed but looks good. The current plan is to include this in 4.0.0 which we'll hopefully work on getting everything merged and released sometime this month.

[TheNullicorn]

I've resolved the requested changes, so it should be ready to merge.

Right now I've got an isOnline() method that uses lastLogin and lastLogout, but I've marked it as deprecated to prefer the status endpoint. Is that fine as-is, or should we not be adding deprecated methods into the API?

[mdashlw]

Right now I've got an isOnline() method that uses lastLogin and lastLogout, but I've marked it as deprecated to prefer the status endpoint. Is that fine as-is, or should we not be adding deprecated methods into the API?

using lastLogin and lastLogout is not deperecated in any way

[TheNullicorn]

Thanks for all the help. Wasn't able to get to a few of your reviews today, but hopefully by tomorrow. If you spot anything else in the changes, or if I prematurely closed one of the conversations, let me know.

[TheNullicorn]

Apologies, I think I pressed re-review twice by mistake. I've left a few of the conversations open for you to look over, but I'm pretty confident the rest are addressed.

[CyberFlameGO]

LGTM!

[TheNullicorn]

I've made the example a bit more friendly for new users, and cleared up some vague docs. I think I'm happy with this now, but reviews are still welcome.

[CyberFlameGO]

Yeah, this looks much more friendly!

[HydroPage]

It was fun helping you, nullicorn. GG on the merge, time to implement this in my applications

[TheNullicorn]

It was fun helping you, nullicorn. GG on the merge, time to implement this in my applications

Thanks for all the helpful comments! Not used to that sort of review, so it was a really nice learning experience