Skip to content

Add package-info.java for internal impl package #495

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.

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
merged 2 commits into from
Apr 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,11 @@ crashlytics.properties
crashlytics-build.properties
fabric.properties

# Eclipse IDE
.classpath
.project
.settings/

### Java template
*.class

Expand Down
2 changes: 1 addition & 1 deletion lib/src/main/java/com/auth0/jwt/impl/NullClaim.java
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import java.util.Map;

/**
* The {@link NullClaim} class is a Claim implementation that returns null when any of it's methods it's called.
* The {@code NullClaim} class is a Claim implementation that returns null when any of it's methods is called.
*/
public class NullClaim implements Claim {
@Override
Expand Down
7 changes: 7 additions & 0 deletions lib/src/main/java/com/auth0/jwt/impl/package-info.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/**
* Contains parts of the <b>internal</b> implementation of this library.
*
* <p><b>Do not use any of the classes in this package.</b> They might be removed
* or changed at any point without prior warning.
*/
package com.auth0.jwt.impl;
3 changes: 2 additions & 1 deletion lib/src/main/java/com/auth0/jwt/interfaces/Header.java
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ public interface Header {
String getKeyId();

/**
* Get a Private Claim given it's name. If the Claim wasn't specified in the Header, a NullClaim will be returned.
* Get a Private Claim given it's name. If the Claim wasn't specified in the Header, a 'null claim' will be
* returned. All of the methods of that claim will return {@code null}.
*
* @param name the name of the Claim to retrieve.
* @return a non-null Claim.
Expand Down
3 changes: 2 additions & 1 deletion lib/src/main/java/com/auth0/jwt/interfaces/Payload.java
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ public interface Payload {
String getId();

/**
* Get a Claim given it's name. If the Claim wasn't specified in the Payload, a NullClaim will be returned.
* Get a Claim given it's name. If the Claim wasn't specified in the Payload, a 'null claim'
* will be returned. All of the methods of that claim will return {@code null}.
*
* @param name the name of the Claim to retrieve.
* @return a non-null Claim.
Expand Down