Use correct <a> tag syntax in javadoc @see tag

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=137946021
This commit is contained in:
jianglai 2016-11-02 08:05:29 -07:00 committed by Ben McIlwain
parent e7d3725f51
commit 59d998954c
42 changed files with 108 additions and 73 deletions

View file

@ -70,12 +70,13 @@ public final class BigqueryJobFailureException extends RuntimeException {
* <h3>Sample Reasons</h3> * <h3>Sample Reasons</h3>
* *
* <ul> * <ul>
* <li>{@code "duplicate"}: The table you're trying to create already exists. * <li>{@code "duplicate"}: The table you're trying to create already exists.
* <li>{@code "invalidQuery"}: Query syntax error of some sort. * <li>{@code "invalidQuery"}: Query syntax error of some sort.
* <li>{@code "unknown"}: Non-Bigquery errors. * <li>{@code "unknown"}: Non-Bigquery errors.
* </ul> * </ul>
* *
* @see "https://cloud.google.com/bigquery/troubleshooting-errors" * @see <a href="https://cloud.google.com/bigquery/troubleshooting-errors">
* Troubleshooting Errors</a>
*/ */
public String getReason() { public String getReason() {
if (jobStatus != null) { if (jobStatus != null) {

View file

@ -98,7 +98,8 @@ public class BigqueryUtils {
* printing because in some cases BigQuery does not allow any time zone specification (instead it * printing because in some cases BigQuery does not allow any time zone specification (instead it
* assumes UTC for whatever input you provide) for input timestamp strings (see b/16380363). * assumes UTC for whatever input you provide) for input timestamp strings (see b/16380363).
* *
* @see "https://developers.google.com/bigquery/timestamp" * @see <a href="https://cloud.google.com/bigquery/data-types#timestamp-type">
* BigQuery Data Types - TIMESTAMP</a>
*/ */
public static final DateTimeFormatter BIGQUERY_TIMESTAMP_FORMAT = new DateTimeFormatterBuilder() public static final DateTimeFormatter BIGQUERY_TIMESTAMP_FORMAT = new DateTimeFormatterBuilder()
.append(ISODateTimeFormat.date()) .append(ISODateTimeFormat.date())
@ -137,7 +138,7 @@ public class BigqueryUtils {
* Converts a time (in TimeUnits since the epoch) into a numeric string that BigQuery understands * Converts a time (in TimeUnits since the epoch) into a numeric string that BigQuery understands
* as a timestamp: the decimal number of seconds since the epoch, precise up to microseconds. * as a timestamp: the decimal number of seconds since the epoch, precise up to microseconds.
* *
* @see "https://developers.google.com/bigquery/timestamp" * @see <a href="https://developers.google.com/bigquery/timestamp">Data Types</a>
*/ */
public static String toBigqueryTimestamp(long timestamp, TimeUnit unit) { public static String toBigqueryTimestamp(long timestamp, TimeUnit unit) {
long seconds = unit.toSeconds(timestamp); long seconds = unit.toSeconds(timestamp);
@ -151,7 +152,7 @@ public class BigqueryUtils {
* *
* <p>Note that since {@code DateTime} only stores milliseconds, the last 3 digits will be zero. * <p>Note that since {@code DateTime} only stores milliseconds, the last 3 digits will be zero.
* *
* @see "https://developers.google.com/bigquery/timestamp" * @see <a href="https://developers.google.com/bigquery/timestamp">Data Types</a>
*/ */
public static String toBigqueryTimestamp(DateTime dateTime) { public static String toBigqueryTimestamp(DateTime dateTime) {
return toBigqueryTimestamp(dateTime.getMillis(), TimeUnit.MILLISECONDS); return toBigqueryTimestamp(dateTime.getMillis(), TimeUnit.MILLISECONDS);

View file

@ -56,7 +56,7 @@ import org.joda.time.Duration;
/** /**
* {@link DnsWriter} implementation that talks to Google Cloud DNS. * {@link DnsWriter} implementation that talks to Google Cloud DNS.
* *
* @see "https://cloud.google.com/dns/docs/" * @see <a href="https://cloud.google.com/dns/docs/">Google Cloud DNS Documentation</a>
*/ */
class CloudDnsWriter implements DnsWriter { class CloudDnsWriter implements DnsWriter {

View file

@ -60,7 +60,7 @@ public class DatastoreBackupService {
/** /**
* Generates the TaskOptions needed to trigger an AppEngine datastore backup job. * Generates the TaskOptions needed to trigger an AppEngine datastore backup job.
* *
* @see "https://developers.google.com/appengine/articles/scheduled_backups" * @see <a href="https://developers.google.com/appengine/articles/scheduled_backups">Scheduled Backups</a>
*/ */
private static TaskOptions makeTaskOptions( private static TaskOptions makeTaskOptions(
String queue, String name, String gcsBucket, ImmutableSet<String> kinds) { String queue, String name, String gcsBucket, ImmutableSet<String> kinds) {

View file

@ -64,7 +64,7 @@ class SheetSynchronizer {
* @throws com.google.gdata.util.ResourceNotFoundException if an entry URL is not valid. * @throws com.google.gdata.util.ResourceNotFoundException if an entry URL is not valid.
* @throws com.google.gdata.util.ServiceForbiddenException if the GData service cannot get the * @throws com.google.gdata.util.ServiceForbiddenException if the GData service cannot get the
* entry resource due to access constraints. * entry resource due to access constraints.
* @see "https://developers.google.com/google-apps/spreadsheets/" * @see <a href="https://developers.google.com/google-apps/spreadsheets/">Google Sheets API</a>
*/ */
void synchronize(String spreadsheetId, ImmutableList<ImmutableMap<String, String>> data) void synchronize(String spreadsheetId, ImmutableList<ImmutableMap<String, String>> data)
throws IOException, ServiceException { throws IOException, ServiceException {

View file

@ -40,7 +40,7 @@ import org.json.simple.JSONValue;
/** /**
* An implementation of the EPP command/response protocol. * An implementation of the EPP command/response protocol.
* *
* @see "http://tools.ietf.org/html/rfc5730" * @see <a href="http://tools.ietf.org/html/rfc5730">RFC 5730 - Extensible Provisioning Protocol</a>
*/ */
public final class EppController { public final class EppController {

View file

@ -80,7 +80,7 @@ public class EppXmlTransformer {
* Unmarshal bytes into Epp classes. * Unmarshal bytes into Epp classes.
* *
* @param clazz type to return, specified as a param to enforce typesafe generics * @param clazz type to return, specified as a param to enforce typesafe generics
* @see "http://errorprone.info/bugpattern/TypeParameterUnusedInFormals" * @see <a href="http://errorprone.info/bugpattern/TypeParameterUnusedInFormals">TypeParameterUnusedInFormals</a>
*/ */
public static <T> T unmarshal(Class<T> clazz, byte[] bytes) throws EppException { public static <T> T unmarshal(Class<T> clazz, byte[] bytes) throws EppException {
try { try {

View file

@ -27,7 +27,8 @@ import javax.xml.bind.annotation.XmlValue;
/** /**
* XML type for contact identifiers associated with a domain. * XML type for contact identifiers associated with a domain.
* *
* @see "http://tools.ietf.org/html/rfc5731#section-2.2" * @see <a href="http://tools.ietf.org/html/rfc5731#section-2.2">
* RFC 5731 - EPP Domain Name Mapping- Contact and Client Identifiers</a>
*/ */
@Embed @Embed
public class DesignatedContact extends ImmutableObject { public class DesignatedContact extends ImmutableObject {

View file

@ -22,7 +22,8 @@ import javax.xml.bind.annotation.XmlValue;
* EPP-compatible version of XML type for contact identifiers associated with a domain, which can * EPP-compatible version of XML type for contact identifiers associated with a domain, which can
* be converted to a storable {@link DesignatedContact}. * be converted to a storable {@link DesignatedContact}.
* *
* @see "http://tools.ietf.org/html/rfc5731#section-2.2" * @see <a href="http://tools.ietf.org/html/rfc5731#section-2.2">
* RFC 5731 - EPP Domain Name Mapping - Contact and Client Identifiers</a>
*/ */
class ForeignKeyedDesignatedContact extends ImmutableObject { class ForeignKeyedDesignatedContact extends ImmutableObject {
@XmlAttribute(required = true) @XmlAttribute(required = true)

View file

@ -105,7 +105,8 @@ public abstract class BaseFee extends ImmutableObject {
* must always be negative. Essentially, they are the same thing, just with different sign. * must always be negative. Essentially, they are the same thing, just with different sign.
* However, we need them to be separate classes for proper JAXB handling. * However, we need them to be separate classes for proper JAXB handling.
* *
* @see "https://tools.ietf.org/html/draft-brown-epp-fees-03#section-2.4" * @see <a href="https://tools.ietf.org/html/draft-brown-epp-fees-03#section-2.4">
* Registry Fee Extension for EPP - Fees and Credits</a>
*/ */
public BigDecimal getCost() { public BigDecimal getCost() {
return cost; return cost;

View file

@ -31,7 +31,8 @@ import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
* *
* <p>Given all of this, we can use {@link EnumToAttributeAdapter} to make this code very simple. * <p>Given all of this, we can use {@link EnumToAttributeAdapter} to make this code very simple.
* *
* @see "http://tools.ietf.org/html/draft-tan-epp-launchphase-11#section-2.3" * @see <a href="http://tools.ietf.org/html/draft-tan-epp-launchphase-11#section-2.3">
* Launch Phase Mapping for EPP - Status Values</a>
*/ */
@XmlJavaTypeAdapter(EnumToAttributeAdapter.class) @XmlJavaTypeAdapter(EnumToAttributeAdapter.class)
public enum ApplicationStatus implements EppEnum { public enum ApplicationStatus implements EppEnum {

View file

@ -23,7 +23,8 @@ import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
* Represents a Registry Grace Period status, as defined by * Represents a Registry Grace Period status, as defined by
* <a href="https://tools.ietf.org/html/rfc3915">RFC 3915</a>. * <a href="https://tools.ietf.org/html/rfc3915">RFC 3915</a>.
* *
* @see "https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en" * @see <a href="https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en">EPP Status
* Codes</a>
*/ */
@XmlJavaTypeAdapter(EnumToAttributeAdapter.class) @XmlJavaTypeAdapter(EnumToAttributeAdapter.class)
public enum GracePeriodStatus implements EppEnum { public enum GracePeriodStatus implements EppEnum {

View file

@ -32,7 +32,8 @@ import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
* <p>Note that {@code StatusValue.LINKED} should never be stored. Rather, it should be calculated * <p>Note that {@code StatusValue.LINKED} should never be stored. Rather, it should be calculated
* on the fly whenever needed using an eventually consistent query (i.e. in info flows). * on the fly whenever needed using an eventually consistent query (i.e. in info flows).
* *
* @see "https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en" * @see <a href="https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en">EPP Status
* Codes</a>
*/ */
@XmlJavaTypeAdapter(StatusValueAdapter.class) @XmlJavaTypeAdapter(StatusValueAdapter.class)
public enum StatusValue implements EppEnum { public enum StatusValue implements EppEnum {

View file

@ -398,7 +398,8 @@ public class EppInput extends ImmutableObject {
* any other version doesn't validate. As a result, if we didn't do this here it would throw a * any other version doesn't validate. As a result, if we didn't do this here it would throw a
* {@code SyntaxErrorException} when it failed to validate. * {@code SyntaxErrorException} when it failed to validate.
* *
* @see "http://tools.ietf.org/html/rfc5730#page-41" * @see <a href="http://tools.ietf.org/html/rfc5730#page-41">
* RFC 5730 - EPP - Command error responses</a>
*/ */
public static class VersionAdapter extends XmlAdapter<String, String> { public static class VersionAdapter extends XmlAdapter<String, String> {
@Override @Override

View file

@ -77,7 +77,8 @@ import javax.xml.bind.annotation.XmlType;
* client. EPP commands are atomic, so a command will either succeed completely or fail completely. * client. EPP commands are atomic, so a command will either succeed completely or fail completely.
* Success and failure results MUST NOT be mixed." * Success and failure results MUST NOT be mixed."
* *
* @see "http://tools.ietf.org/html/rfc5730#section-2.6" * @see <a href="http://tools.ietf.org/html/rfc5730#section-2.6">
* RFC 5730 - EPP - Response Format</a>
*/ */
@XmlType(propOrder = {"result", "messageQueueInfo", "resData", "extensions", "trid"}) @XmlType(propOrder = {"result", "messageQueueInfo", "resData", "extensions", "trid"})
public class EppResponse extends ImmutableObject implements ResponseOrGreeting { public class EppResponse extends ImmutableObject implements ResponseOrGreeting {

View file

@ -132,7 +132,8 @@ public class Result extends ImmutableObject {
/** /**
* An RFC 4646 language code. * An RFC 4646 language code.
* *
* @see "http://tools.ietf.org/html/rfc4646" * @see <a href="http://tools.ietf.org/html/rfc4646">
* RFC 4646 - Tags for Identifying Languages</a>
*/ */
public final String msgLang; public final String msgLang;

View file

@ -41,12 +41,13 @@ import org.joda.time.DateTime;
/** /**
* Root for a random commit log bucket. * Root for a random commit log bucket.
* *
* <p>This is used to shard {@link CommitLogManifest} objects into * <p>This is used to shard {@link CommitLogManifest} objects into {@link
* {@link google.registry.config.RegistryConfig#getCommitLogBucketCount() N} entity * google.registry.config.RegistryConfig#getCommitLogBucketCount() N} entity groups. This increases
* groups. This increases transaction throughput, while maintaining the ability to perform * transaction throughput, while maintaining the ability to perform strongly-consistent ancestor
* strongly-consistent ancestor queries. * queries.
* *
* @see "https://cloud.google.com/appengine/articles/scaling/contention" * @see <a href="https://cloud.google.com/appengine/articles/scaling/contention">Avoiding datastore
* contention</a>
*/ */
@Entity @Entity
@NotBackedUp(reason = Reason.COMMIT_LOGS) @NotBackedUp(reason = Reason.COMMIT_LOGS)

View file

@ -68,7 +68,8 @@ import org.joda.time.DateTime;
* <p>Poll messages are identified externally by registrars using the format defined in {@link * <p>Poll messages are identified externally by registrars using the format defined in {@link
* PollMessageExternalKeyConverter}. * PollMessageExternalKeyConverter}.
* *
* @see "https://tools.ietf.org/html/rfc5730#section-2.9.2.3" * @see <a href="https://tools.ietf.org/html/rfc5730#section-2.9.2.3">
* RFC5730 - EPP - &ltpoll&gt Command</a>
*/ */
@Entity @Entity
@ExternalMessagingName("message") @ExternalMessagingName("message")

View file

@ -28,7 +28,7 @@ public enum RdeMode {
* <p>This mode of operation provides ICANN with minimal information about registered domains * <p>This mode of operation provides ICANN with minimal information about registered domains
* and their associated registrars, per gTLD Registry Agreement, Specification 4 § 3.1. * and their associated registrars, per gTLD Registry Agreement, Specification 4 § 3.1.
* *
* @see "http://newgtlds.icann.org/en/applicants/agb/agreement-approved-09jan14-en.htm" * @see <a href="http://newgtlds.icann.org/en/applicants/agb/agreement-approved-09jan14-en.htm">Registry Agreement</a>
*/ */
THIN; THIN;

View file

@ -117,7 +117,7 @@ public class Registrar extends ImmutableObject implements Buildable, Jsonifiable
/** /**
* Predicate for validating IANA IDs for this type of registrar. * Predicate for validating IANA IDs for this type of registrar.
* *
* @see "http://www.iana.org/assignments/registrar-ids/registrar-ids.txt" * @see <a href="http://www.iana.org/assignments/registrar-ids/registrar-ids.txt">Registrar IDs</a>
*/ */
private final Predicate<Long> ianaIdValidator; private final Predicate<Long> ianaIdValidator;
@ -186,7 +186,7 @@ public class Registrar extends ImmutableObject implements Buildable, Jsonifiable
/** /**
* Unique registrar client id. Must conform to "clIDType" as defined in RFC5730. * Unique registrar client id. Must conform to "clIDType" as defined in RFC5730.
* @see "http://tools.ietf.org/html/rfc5730#section-4.2" * @see <a href="http://tools.ietf.org/html/rfc5730#section-4.2">Shared Structure Schema</a>
*/ */
@Id @Id
String clientIdentifier; String clientIdentifier;
@ -199,7 +199,7 @@ public class Registrar extends ImmutableObject implements Buildable, Jsonifiable
* formally enforced in our datastore, but should be enforced by ICANN in that no two registrars * formally enforced in our datastore, but should be enforced by ICANN in that no two registrars
* will be accredited with the same name. * will be accredited with the same name.
* *
* @see "http://www.icann.org/registrar-reports/accredited-list.html" * @see <a href="http://www.icann.org/registrar-reports/accredited-list.html">ICANN-Accredited Registrars</a>
*/ */
@Index @Index
String registrarName; String registrarName;
@ -284,7 +284,7 @@ public class Registrar extends ImmutableObject implements Buildable, Jsonifiable
* <li>9997 is used by ICAAN for SLA monitoring. * <li>9997 is used by ICAAN for SLA monitoring.
* <li>9999 is used for cases when the registry operator acts as registrar. * <li>9999 is used for cases when the registry operator acts as registrar.
* </ul> * </ul>
* @see "http://www.iana.org/assignments/registrar-ids/registrar-ids.txt" * @see <a href="http://www.iana.org/assignments/registrar-ids/registrar-ids.txt">Registrar IDs</a>
*/ */
@Index @Index
Long ianaIdentifier; Long ianaIdentifier;

View file

@ -59,7 +59,8 @@ import org.joda.time.DateTime;
* entity into multiple entities, each entity containing {@value #SHARD_SIZE} rows. * entity into multiple entities, each entity containing {@value #SHARD_SIZE} rows.
* *
* @see google.registry.tmch.SmdrlCsvParser * @see google.registry.tmch.SmdrlCsvParser
* @see "http://tools.ietf.org/html/draft-lozano-tmch-func-spec-08#section-6.2" * @see <a href="http://tools.ietf.org/html/draft-lozano-tmch-func-spec-08#section-6.2">
* TMCH functional specifications - SMD Revocation List</a>
*/ */
@Entity @Entity
@NotBackedUp(reason = Reason.EXTERNALLY_SOURCED) @NotBackedUp(reason = Reason.EXTERNALLY_SOURCED)

View file

@ -63,7 +63,8 @@ import org.joda.time.format.ISODateTimeFormat;
* CPU, it buffers points to be written until it has {@code maxPointsPerRequest} points buffered or * CPU, it buffers points to be written until it has {@code maxPointsPerRequest} points buffered or
* until {@link #flush()} is called. * until {@link #flush()} is called.
* *
* @see <a href="Stackdriver API Introduction">https://cloud.google.com/monitoring/api/v3/</a> * @see <a href="https://cloud.google.com/monitoring/api/v3/">Introduction to the Stackdriver
* Monitoring API</a>
*/ */
// TODO(shikhman): add retry logic // TODO(shikhman): add retry logic
@NotThreadSafe @NotThreadSafe

View file

@ -20,7 +20,7 @@ import com.google.common.collect.ImmutableMap;
/** /**
* This file contains boilerplate required by the ICANN RDAP Profile. * This file contains boilerplate required by the ICANN RDAP Profile.
* *
* @see "https://www.icann.org/resources/pages/rdap-operational-profile-2016-07-26-en" * @see <a href="https://www.icann.org/resources/pages/rdap-operational-profile-2016-07-26-en">RDAP Operational Profile for gTLD Registries and Registrars</a>
*/ */
public class RdapIcannStandardInformation { public class RdapIcannStandardInformation {
@ -75,7 +75,7 @@ public class RdapIcannStandardInformation {
/** /**
* Required by ICANN RDAP Profile section 1.4.9, as corrected by Gustavo Lozano of ICANN. * Required by ICANN RDAP Profile section 1.4.9, as corrected by Gustavo Lozano of ICANN.
* *
* @see "http://mm.icann.org/pipermail/gtld-tech/2016-October/000822.html" * @see <a href="http://mm.icann.org/pipermail/gtld-tech/2016-October/000822.html">Questions about the ICANN RDAP Profile</a>
*/ */
static final ImmutableMap<String, Object> SUMMARY_DATA_REMARK = static final ImmutableMap<String, Object> SUMMARY_DATA_REMARK =
ImmutableMap.<String, Object> of( ImmutableMap.<String, Object> of(
@ -90,7 +90,7 @@ public class RdapIcannStandardInformation {
/** /**
* Required by ICANN RDAP Profile section 1.4.8, as corrected by Gustavo Lozano of ICANN. * Required by ICANN RDAP Profile section 1.4.8, as corrected by Gustavo Lozano of ICANN.
* *
* @see "http://mm.icann.org/pipermail/gtld-tech/2016-October/000822.html" * @see <a href="http://mm.icann.org/pipermail/gtld-tech/2016-October/000822.html">Questions about the ICANN RDAP Profile</a>
*/ */
static final ImmutableMap<String, Object> TRUNCATED_RESULT_SET_NOTICE = static final ImmutableMap<String, Object> TRUNCATED_RESULT_SET_NOTICE =
ImmutableMap.<String, Object> of( ImmutableMap.<String, Object> of(

View file

@ -50,7 +50,7 @@ import org.joda.time.DateTime;
* This bucket is special because a separate script will rsync it to the third party escrow provider * This bucket is special because a separate script will rsync it to the third party escrow provider
* SFTP server. This is why the internal staging files are stored in the separate RDE bucket. * SFTP server. This is why the internal staging files are stored in the separate RDE bucket.
* *
* @see "http://newgtlds.icann.org/en/applicants/agb/agreement-approved-09jan14-en.htm" * @see <a href="http://newgtlds.icann.org/en/applicants/agb/agreement-approved-09jan14-en.htm">Registry Agreement</a>
*/ */
@Action(path = BrdaCopyAction.PATH, method = POST, automaticallyPrintOk = true) @Action(path = BrdaCopyAction.PATH, method = POST, automaticallyPrintOk = true)
public final class BrdaCopyAction implements Runnable { public final class BrdaCopyAction implements Runnable {

View file

@ -55,7 +55,8 @@ public class RdeReporter {
private static final FormattingLogger logger = FormattingLogger.getLoggerForCallerClass(); private static final FormattingLogger logger = FormattingLogger.getLoggerForCallerClass();
/** @see "http://tools.ietf.org/html/draft-lozano-icann-registry-interfaces-05#section-4" */ /** @see <a href="http://tools.ietf.org/html/draft-lozano-icann-registry-interfaces-05#section-4">
* ICANN Registry Interfaces - Interface details</a>*/
private static final String REPORT_MIME = "text/xml"; private static final String REPORT_MIME = "text/xml";
@Inject RegistryConfig config; @Inject RegistryConfig config;
@ -102,7 +103,8 @@ public class RdeReporter {
/** /**
* Unmarshals IIRDEA XML result object from {@link HTTPResponse} payload. * Unmarshals IIRDEA XML result object from {@link HTTPResponse} payload.
* *
* @see "http://tools.ietf.org/html/draft-lozano-icann-registry-interfaces-05#section-4.1" * @see <a href="http://tools.ietf.org/html/draft-lozano-icann-registry-interfaces-05#section-4.1">
* ICANN Registry Interfaces - IIRDEA Result Object</a>
*/ */
private XjcIirdeaResult parseResult(HTTPResponse rsp) throws XmlException { private XjcIirdeaResult parseResult(HTTPResponse rsp) throws XmlException {
byte[] responseBytes = rsp.getContent(); byte[] responseBytes = rsp.getContent();

View file

@ -150,8 +150,8 @@ import org.joda.time.Duration;
* guarantee referential correctness of your deposits, you must never delete a registrar entity. * guarantee referential correctness of your deposits, you must never delete a registrar entity.
* </ul> * </ul>
* *
* @see "https://tools.ietf.org/html/draft-arias-noguchi-registry-data-escrow-06" * @see <a href="https://tools.ietf.org/html/draft-arias-noguchi-registry-data-escrow-06">Registry Data Escrow Specification</a>
* @see "https://tools.ietf.org/html/draft-arias-noguchi-dnrd-objects-mapping-05" * @see <a href="https://tools.ietf.org/html/draft-arias-noguchi-dnrd-objects-mapping-05">Domain Name Registration Data Objects Mapping</a>
*/ */
@Action(path = "/_dr/task/rdeStaging") @Action(path = "/_dr/task/rdeStaging")
public final class RdeStagingAction implements Runnable { public final class RdeStagingAction implements Runnable {

View file

@ -40,7 +40,8 @@ public final class IdnTable {
/** /**
* Public URL of this IDN table, which is needed by RDE. * Public URL of this IDN table, which is needed by RDE.
* *
* @see "https://tools.ietf.org/html/draft-arias-noguchi-dnrd-objects-mapping-05#section-5.5.1.1" * @see <a href="https://tools.ietf.org/html/draft-arias-noguchi-dnrd-objects-mapping-05#section-5.5.1.1">
* DNRD Objects Mapping - &ltrdeIDN:idnTableRef&gt object</a>
*/ */
private final URI url; private final URI url;

View file

@ -28,7 +28,8 @@ import org.joda.time.DateTime;
* <p>This is a quick and dirty CSV parser made specifically for the DNL CSV format defined in the * <p>This is a quick and dirty CSV parser made specifically for the DNL CSV format defined in the
* TMCH specification. It doesn't support any fancy CSV features like quotes. * TMCH specification. It doesn't support any fancy CSV features like quotes.
* *
* @see "http://tools.ietf.org/html/draft-lozano-tmch-func-spec-08#section-6.1" * @see <a href="http://tools.ietf.org/html/draft-lozano-tmch-func-spec-08#section-6.1">
* TMCH functional specifications - DNL List file</a>
*/ */
public class ClaimsListParser { public class ClaimsListParser {

View file

@ -33,7 +33,8 @@ import org.joda.time.DateTime;
/** /**
* Parser of LORDN log responses from the MarksDB server during the NORDN process. * Parser of LORDN log responses from the MarksDB server during the NORDN process.
* *
* @see "http://tools.ietf.org/html/draft-lozano-tmch-func-spec-08#section-6.3.1" * @see <a href="http://tools.ietf.org/html/draft-lozano-tmch-func-spec-08#section-6.3.1">
* TMCH functional specifications - LORDN Log File</a>
*/ */
@Immutable @Immutable
public final class LordnLog implements Iterable<Entry<String, LordnLog.Result>> { public final class LordnLog implements Iterable<Entry<String, LordnLog.Result>> {

View file

@ -121,7 +121,8 @@ public final class NordnUploadAction implements Runnable {
* <p>Idempotency: If the exact same LORDN report is uploaded twice, the MarksDB server will * <p>Idempotency: If the exact same LORDN report is uploaded twice, the MarksDB server will
* return the same confirmation number. * return the same confirmation number.
* *
* @see "http://tools.ietf.org/html/draft-lozano-tmch-func-spec-08#section-6.3" * @see <a href="http://tools.ietf.org/html/draft-lozano-tmch-func-spec-08#section-6.3">
* TMCH functional specifications - LORDN File</a>
*/ */
private void uploadCsvToLordn(String urlPath, String csvData) throws IOException { private void uploadCsvToLordn(String urlPath, String csvData) throws IOException {
String url = tmchMarksdbUrl + urlPath; String url = tmchMarksdbUrl + urlPath;

View file

@ -88,7 +88,8 @@ public final class NordnVerifyAction implements Runnable {
* available. * available.
* *
* @throws ConflictException if MarksDB has not yet finished processing the LORDN upload * @throws ConflictException if MarksDB has not yet finished processing the LORDN upload
* @see "http://tools.ietf.org/html/draft-lozano-tmch-func-spec-08#section-6.3.1" * @see <a href="http://tools.ietf.org/html/draft-lozano-tmch-func-spec-08#section-6.3.1">
* TMCH functional specifications LORDN Log File</a>
*/ */
@VisibleForTesting @VisibleForTesting
LordnLog verify() throws IOException { LordnLog verify() throws IOException {

View file

@ -29,7 +29,8 @@ import org.joda.time.DateTime;
* <p>This is a quick and dirty CSV parser made specifically for the SMDRL CSV format defined in * <p>This is a quick and dirty CSV parser made specifically for the SMDRL CSV format defined in
* the TMCH specification. It doesn't support any fancy CSV features like quotes. * the TMCH specification. It doesn't support any fancy CSV features like quotes.
* *
* @see "http://tools.ietf.org/html/draft-lozano-tmch-func-spec-08#section-6.2" * @see <a href="http://tools.ietf.org/html/draft-lozano-tmch-func-spec-08#section-6.2">
* TMCH functional specifications - SMD Revocation List</a>
*/ */
public final class SmdrlCsvParser { public final class SmdrlCsvParser {

View file

@ -36,7 +36,7 @@ final class BigqueryParameters {
/** /**
* Default to 20 threads to stay within Bigquery's rate limit of 20 concurrent queries. * Default to 20 threads to stay within Bigquery's rate limit of 20 concurrent queries.
* *
* @see "https://cloud.google.com/bigquery/quota-policy" * @see <a href="https://cloud.google.com/bigquery/quota-policy">BigQuery Quota Policy</a>
*/ */
private static final int DEFAULT_NUM_THREADS = 20; private static final int DEFAULT_NUM_THREADS = 20;

View file

@ -41,7 +41,7 @@ public final class FormFields {
* *
* <p>This trims the input and collapses whitespace. * <p>This trims the input and collapses whitespace.
* *
* @see "http://www.w3.org/TR/xmlschema11-2/#token" * @see <a href="http://www.w3.org/TR/xmlschema11-2/#token">XSD Datatypes - token</a>
*/ */
public static final FormField<String, String> XS_TOKEN = FormField.named("xsToken") public static final FormField<String, String> XS_TOKEN = FormField.named("xsToken")
.emptyToNull() .emptyToNull()
@ -52,7 +52,8 @@ public final class FormFields {
/** /**
* Form field that ensures input does not contain tabs, line feeds, or carriage returns. * Form field that ensures input does not contain tabs, line feeds, or carriage returns.
* *
* @see "http://www.w3.org/TR/xmlschema11-2/#normalizedString" * @see <a href="http://www.w3.org/TR/xmlschema11-2/#normalizedString">
* XSD Datatypes - normalizedString</a>
*/ */
public static final FormField<String, String> XS_NORMALIZED_STRING = public static final FormField<String, String> XS_NORMALIZED_STRING =
FormField.named("xsNormalizedString") FormField.named("xsNormalizedString")
@ -63,7 +64,7 @@ public final class FormFields {
/** /**
* Form field for +E164 phone numbers with a dot after the country prefix. * Form field for +E164 phone numbers with a dot after the country prefix.
* *
* @see "http://tools.ietf.org/html/rfc5733#section-4" * @see <a href="http://tools.ietf.org/html/rfc5733#section-4">RFC 5733 - EPP - Formal Syntax</a>
*/ */
public static final FormField<String, String> PHONE_NUMBER = public static final FormField<String, String> PHONE_NUMBER =
XS_TOKEN.asBuilderNamed("phoneNumber") XS_TOKEN.asBuilderNamed("phoneNumber")
@ -113,7 +114,7 @@ public final class FormFields {
/** /**
* Ensure value is an EPP Repository Object IDentifier (ROID). * Ensure value is an EPP Repository Object IDentifier (ROID).
* *
* @see "http://tools.ietf.org/html/rfc5730#section-4.2" * @see <a href="http://tools.ietf.org/html/rfc5730#section-4.2">Shared Structure Schema</a>
*/ */
public static final FormField<String, String> ROID = XS_TOKEN.asBuilderNamed("roid") public static final FormField<String, String> ROID = XS_TOKEN.asBuilderNamed("roid")
.matches(Pattern.compile("(\\w|_){1,80}-\\w{1,8}"), .matches(Pattern.compile("(\\w|_){1,80}-\\w{1,8}"),

View file

@ -19,7 +19,7 @@ import com.google.common.collect.ImmutableBiMap;
/** /**
* Bimap of state codes and names for the US Regime. * Bimap of state codes and names for the US Regime.
* *
* @see "http://statetable.com/" * @see <a href="http://statetable.com/">State Table</a>
*/ */
public final class StateCode { public final class StateCode {

View file

@ -207,8 +207,10 @@ public final class RegistrarPaymentAction implements Runnable, JsonAction {
/** /**
* Handles a transaction success response. * Handles a transaction success response.
* *
* @see "https://developers.braintreepayments.com/reference/response/transaction/java#success" * @see <a href="https://developers.braintreepayments.com/reference/response/transaction/java#success">
* @see "https://developers.braintreepayments.com/reference/general/statuses#transaction" * Braintree - Transaction - Success</a>
* @see <a href="https://developers.braintreepayments.com/reference/general/statuses#transaction">
* Braintree - Statuses - Transaction</a>
*/ */
private Map<String, Object> handleSuccessResponse(Transaction transaction) { private Map<String, Object> handleSuccessResponse(Transaction transaction) {
// XXX: Currency scaling: https://github.com/braintree/braintree_java/issues/33 // XXX: Currency scaling: https://github.com/braintree/braintree_java/issues/33
@ -232,8 +234,10 @@ public final class RegistrarPaymentAction implements Runnable, JsonAction {
* *
* <p>This happens when the customer's bank blocks the transaction. * <p>This happens when the customer's bank blocks the transaction.
* *
* @see "https://developers.braintreepayments.com/reference/response/transaction/java#processor-declined" * @see <a href="https://developers.braintreepayments.com/reference/response/transaction/java#processor-declined">
* @see "https://articles.braintreepayments.com/control-panel/transactions/declines" * Braintree - Transaction - Processor declined</a>
* @see <a href="https://articles.braintreepayments.com/control-panel/transactions/declines">
* Braintree - Transactions/Declines</a>
*/ */
private Map<String, Object> handleProcessorDeclined(Transaction transaction) { private Map<String, Object> handleProcessorDeclined(Transaction transaction) {
logger.warningfmt("Processor declined: %s %s", logger.warningfmt("Processor declined: %s %s",
@ -248,8 +252,10 @@ public final class RegistrarPaymentAction implements Runnable, JsonAction {
* <p>This is a very rare condition that, for all intents and purposes, means the same thing as a * <p>This is a very rare condition that, for all intents and purposes, means the same thing as a
* processor declined response. * processor declined response.
* *
* @see "https://developers.braintreepayments.com/reference/response/transaction/java#processor-settlement-declined" * @see <a href="https://developers.braintreepayments.com/reference/response/transaction/java#processor-settlement-declined">
* @see "https://articles.braintreepayments.com/control-panel/transactions/declines" * Braintree - Transaction - Processor settlement declined</a>
* @see <a href="https://articles.braintreepayments.com/control-panel/transactions/declines">
* Braintree - Transactions/Declines</a>
*/ */
private Map<String, Object> handleSettlementDecline(Transaction transaction) { private Map<String, Object> handleSettlementDecline(Transaction transaction) {
logger.warningfmt("Settlement declined: %s %s", logger.warningfmt("Settlement declined: %s %s",
@ -265,10 +271,14 @@ public final class RegistrarPaymentAction implements Runnable, JsonAction {
* <p>This happens when a transaction is blocked due to settings we configured ourselves in the * <p>This happens when a transaction is blocked due to settings we configured ourselves in the
* Braintree control panel. * Braintree control panel.
* *
* @see "https://developers.braintreepayments.com/reference/response/transaction/java#gateway-rejection" * @see <a href="https://developers.braintreepayments.com/reference/response/transaction/java#gateway-rejection">
* @see "https://articles.braintreepayments.com/control-panel/transactions/gateway-rejections" * Braintree - Transaction - Gateway rejection</a>
* @see "https://articles.braintreepayments.com/guides/fraud-tools/avs-cvv" * @see <a href="https://articles.braintreepayments.com/control-panel/transactions/gateway-rejections">
* @see "https://articles.braintreepayments.com/guides/fraud-tools/overview" * Braintree - Transactions/Gateway Rejections</a>
* @see <a href="https://articles.braintreepayments.com/guides/fraud-tools/avs-cvv">
* Braintree - Fruad Tools/Basic Fraud Tools - AVS and CVV rules</a>
* @see <a href="https://articles.braintreepayments.com/guides/fraud-tools/overview">
* Braintree - Fraud Tools/Overview</a>
*/ */
private Map<String, Object> handleRejection(Transaction transaction) { private Map<String, Object> handleRejection(Transaction transaction) {
logger.warningfmt("Gateway rejection: %s", transaction.getGatewayRejectionReason()); logger.warningfmt("Gateway rejection: %s", transaction.getGatewayRejectionReason());
@ -306,8 +316,10 @@ public final class RegistrarPaymentAction implements Runnable, JsonAction {
/** /**
* Handles a validation error response from Braintree. * Handles a validation error response from Braintree.
* *
* @see "https://developers.braintreepayments.com/reference/response/transaction/java#validation-errors" * @see <a href="https://developers.braintreepayments.com/reference/response/transaction/java#validation-errors">
* @see "https://developers.braintreepayments.com/reference/general/validation-errors/all/java" * Braintree - Transaction - Validation errors</a>
* @see <a href="https://developers.braintreepayments.com/reference/general/validation-errors/all/java">
* Braintree - Validation Errors/All</a>
*/ */
private Map<String, Object> handleValidationErrorResponse(ValidationErrors validationErrors) { private Map<String, Object> handleValidationErrorResponse(ValidationErrors validationErrors) {
List<ValidationError> errors = validationErrors.getAllDeepValidationErrors(); List<ValidationError> errors = validationErrors.getAllDeepValidationErrors();

View file

@ -61,7 +61,7 @@ import org.joda.money.CurrencyUnit;
* {@code registry.rpc.PaymentSetup} which must be updated should these definitions change. * {@code registry.rpc.PaymentSetup} which must be updated should these definitions change.
* *
* @see RegistrarPaymentAction * @see RegistrarPaymentAction
* @see "https://developers.braintreepayments.com/start/hello-server/java#generate-a-client-token" * @see <a href="https://developers.braintreepayments.com/start/hello-server/java#generate-a-client-token">Generate a client token</a>
*/ */
@Action( @Action(
path = "/registrar-payment-setup", path = "/registrar-payment-setup",

View file

@ -23,7 +23,7 @@ public class PredicateUtils {
* A predicate for a given class X that checks if tested classes are supertypes of X. * A predicate for a given class X that checks if tested classes are supertypes of X.
* *
* <p>We need our own predicate because Guava's class predicates are backwards. * <p>We need our own predicate because Guava's class predicates are backwards.
* @see "https://github.com/google/guava/issues/1444" * @see <a href="https://github.com/google/guava/issues/1444">Guava issue #1444</a>
*/ */
private static class SupertypeOfPredicate implements Predicate<Class<?>> { private static class SupertypeOfPredicate implements Predicate<Class<?>> {

View file

@ -64,7 +64,7 @@ public final class UrlFetchUtils {
* *
* <p>This is equivalent to running the command: {@code curl -F fieldName=@payload.txt URL} * <p>This is equivalent to running the command: {@code curl -F fieldName=@payload.txt URL}
* *
* @see "http://www.ietf.org/rfc/rfc2388.txt" * @see <a href="http://www.ietf.org/rfc/rfc2388.txt"> RFC2388 - Returning Values from Forms</a>
*/ */
public static <T> void setPayloadMultipart( public static <T> void setPayloadMultipart(
HTTPRequest request, String name, String filename, MediaType contentType, T data) { HTTPRequest request, String name, String filename, MediaType contentType, T data) {

View file

@ -140,7 +140,7 @@ public class XmlTransformer {
* element doesn't match {@code expect}. * element doesn't match {@code expect}.
* @see com.google.common.io.Files#asByteSource * @see com.google.common.io.Files#asByteSource
* @see com.google.common.io.Resources#asByteSource * @see com.google.common.io.Resources#asByteSource
* @see "http://errorprone.info/bugpattern/TypeParameterUnusedInFormals" * @see <a href="http://errorprone.info/bugpattern/TypeParameterUnusedInFormals">TypeParameterUnusedInFormals</a>
*/ */
public <T> T unmarshal(Class<T> clazz, InputStream stream) throws XmlException { public <T> T unmarshal(Class<T> clazz, InputStream stream) throws XmlException {
try (InputStream autoClosingStream = stream) { try (InputStream autoClosingStream = stream) {

View file

@ -249,7 +249,8 @@ public final class RequestHandlerTest {
verify(rsp).sendError(405); verify(rsp).sendError(405);
} }
/** @see "http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html#sec5.1.1" */ /** @see <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html#sec5.1.1">
* RFC2616 - HTTP/1.1 - Method</a> */
@Test @Test
public void testHandleRequest_lowercaseMethod_notRecognized() throws Exception { public void testHandleRequest_lowercaseMethod_notRecognized() throws Exception {
when(req.getMethod()).thenReturn("get"); when(req.getMethod()).thenReturn("get");

View file

@ -909,8 +909,6 @@ public class DatastoreHelper {
/** /**
* Like persistResource but for multiple entities, with no helper for saving * Like persistResource but for multiple entities, with no helper for saving
* ForeignKeyedEppResources. * ForeignKeyedEppResources.
*
* @see "http://docs.objectify-appengine.googlecode.com/git/apidocs/com/googlecode/objectify/cmd/Loader.htmls#entities(java.lang.Iterable)"
*/ */
public static <R> ImmutableList<R> persistSimpleResources(final Iterable<R> resources) { public static <R> ImmutableList<R> persistSimpleResources(final Iterable<R> resources) {
ofy().transact(new VoidWork(){ ofy().transact(new VoidWork(){