Skip to content
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
6 changes: 6 additions & 0 deletions build-logic/src/main/kotlin/polaris-java.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,9 @@ spotless {
}

dependencies { errorprone(versionCatalogs.named("libs").findLibrary("errorprone").get()) }

tasks.withType<Javadoc>().configureEach {
val opt = options as CoreJavadocOptions
// don't spam log w/ "warning: no @param/@return"
opt.addStringOption("Xdoclint:-reference", "-quiet")
}
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,9 @@ public class PolarisEntityConstants {
"CREDENTIAL_ROTATION_REQUIRED";

/**
* Name format of storage integration for polaris entity: POLARIS_<catalog_id>_<entity_id> . This
* name format gives us flexibility to switch to use integration name in the future if we want.
* Name format of storage integration for polaris entity: {@code
* POLARIS_<catalog_id>_<entity_id>}. This name format gives us flexibility to switch to use
* integration name in the future if we want.
*/
public static final String POLARIS_STORAGE_INT_NAME_FORMAT = "POLARIS_%s_%s";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1323,7 +1323,7 @@ public Map<String, String> getValidateResult() {
* @param entityId the entity id
* @param actions a set of operation actions: READ/WRITE/LIST/DELETE/ALL
* @param locations a set of locations to verify
* @return a Map of <location, validate result>, a validate result value looks like this
* @return a Map of {@code <location, validate result>}, a validate result value looks like this
* <pre>
* {
* "status" : "failure",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -855,7 +855,7 @@ public String serializeProperties(PolarisCallContext callCtx, Map<String, String
}

/**
* Given the serialized properties, deserialize those to a Map<String, String>
* Given the serialized properties, deserialize those to a {@code Map<String, String>}
*
* @param properties a JSON string representing the set of properties
* @return a Map of string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ public static <T> T deserialize(PolarisCallContext callCtx, String text, Class<T
}

/**
* Given the serialized properties, deserialize those to a Map<String, String>
* Given the serialized properties, deserialize those to a {@code Map<String, String>}
*
* @param properties a JSON string representing the set of properties
* @return a Map of string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
* <pre>
* 1. locations that allows polaris to get access to
* 2. cloud identity info that a service principle can request access token to the locations
* </pre</>
* </pre>
*/
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME)
@JsonSubTypes({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ public abstract EnumMap<PolarisCredentialProperty, String> getSubscopedCreds(
*
* @param actions a set of operation actions to validate, like LIST/READ/DELETE/WRITE/ALL
* @param locations a set of locations to get access to
* @return A Map of string, representing the result of validation, the key value is <location,
* validate result>. A validate result looks like this
* @return A Map of string, representing the result of validation, the key value is {@code
* <location, validate result>}. A validate result looks like this
* <pre>
* {
* "status" : "failure",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public class AzureLocation {
/**
* Construct an Azure location object from a location uri, it should follow this pattern:
*
* <pre> abfs[s]://[<container>@]<storage account host>/<file path> </pre>
* <p>{@code abfs[s]://[<container>@]<storage account host>/<file path>}
*
* @param location a uri
*/
Expand Down