Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/deprecated-list.html b/javadoc/deprecated-list.html new file mode 100644 index 00000000..2c518fda --- /dev/null +++ b/javadoc/deprecated-list.html @@ -0,0 +1,413 @@ + + + + + + +Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/help-doc.html b/javadoc/help-doc.html new file mode 100644 index 00000000..ae3efc53 --- /dev/null +++ b/javadoc/help-doc.html @@ -0,0 +1,231 @@ + + + + + + +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/index-all.html b/javadoc/index-all.html new file mode 100644 index 00000000..7667131e --- /dev/null +++ b/javadoc/index-all.html @@ -0,0 +1,769 @@ + + + + + + +EcommerceItem to this order.EcommerceItem from this order.EcommerceItem instead.CustomVariable instead.CustomVariable instead.EcommerceItem instead.EcommerceItem instead.EcommerceItem instead.MatomoRequest#setGoalId(Integer) insteadEcommerceItem at the specified index.Locale.forLanguageTag(String)MatomoRequest.getPageCustomVariable(int) method instead.MatomoRequest#getPageCustomVariables() instead#getRequestTimestamp() insteadMatomoRequest.getVisitCustomVariable(int) method instead.#getVisitCustomVariables() insteadInstantCountry insteadCountryMatomoRequest#builder()MatomoRequests to a specified Matomo server.MatomoTracker(TrackerConfiguration)MatomoTracker(TrackerConfiguration)MatomoTracker(TrackerConfiguration)MatomoTracker(TrackerConfiguration)MatomoTracker
+ with the corresponding TrackerConfiguration.InstantInstant instead.Instant instead.Country instead.Country instead.MatomoRequest instead.MatomoRequest instead.MatomoTracker instead.MatomoTracker instead.MatomoTracker instead.MatomoTracker instead.MatomoTracker instead.Locale.getCountry()MatomoRequest#getPageCustomVariables() instead#getPageCustomVariables() instead#setRequestTimestamp(Instant) insteadObject.toString().ChronoZonedDateTime.toInstant() instead.#setVisitCustomVariables(CustomVariables) instead#setVisitCustomVariables(CustomVariables) insteadCopyright © 2023. All rights reserved.
+ + diff --git a/javadoc/index.html b/javadoc/index.html new file mode 100644 index 00000000..9ed7912b --- /dev/null +++ b/javadoc/index.html @@ -0,0 +1,76 @@ + + + + + + +EcommerceItem instead.@Deprecated +public class CustomVariable +extends CustomVariable+
| Constructor and Description | +
|---|
CustomVariable(@NonNull String key,
+ @NonNull String value)
+Deprecated.
+Instantiates a new custom variable.
+ |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/EcommerceItem.html b/javadoc/org/matomo/java/tracking/EcommerceItem.html new file mode 100644 index 00000000..f2a60419 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/EcommerceItem.html @@ -0,0 +1,281 @@ + + + + + + +EcommerceItem instead.@Deprecated +public class EcommerceItem +extends EcommerceItem+
public EcommerceItem(String sku, + String name, + String category, + Double price, + Integer quantity)+
sku - the sku (Stock Keeping Unit) of the itemname - the name of the itemcategory - the category of the itemprice - the price of the itemquantity - the quantity of the itemCopyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/InvalidUrlException.html b/javadoc/org/matomo/java/tracking/InvalidUrlException.html new file mode 100644 index 00000000..18fb59b5 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/InvalidUrlException.html @@ -0,0 +1,230 @@ + + + + + + +public class InvalidUrlException +extends RuntimeException+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringCopyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/MatomoDate.html b/javadoc/org/matomo/java/tracking/MatomoDate.html new file mode 100644 index 00000000..bbfa6b29 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/MatomoDate.html @@ -0,0 +1,351 @@ + + + + + + +Instant@Deprecated +public class MatomoDate +extends Object+
yyyy-MM-dd hh:mm:ss.| Constructor and Description | +
|---|
MatomoDate()
+Deprecated.
+ |
+
MatomoDate(long epochMilli)
+Deprecated.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
long |
+getTime()
+Deprecated.
+Converts this datetime to the number of milliseconds from the epoch
+ of 1970-01-01T00:00:00Z.
+ |
+
void |
+setTimeZone(ZoneId zone)
+Deprecated.
+Sets the time zone of the String that will be returned by
+Object.toString(). |
+
@Deprecated +public MatomoDate()+
@Deprecated +public MatomoDate(long epochMilli)+
epochMilli - the milliseconds since January 1, 1970, 00:00:00 GMT.public void setTimeZone(ZoneId zone)+
Object.toString().
+ Defaults to UTC.zone - the TimeZone to setpublic long getTime()+
ArithmeticException - if numeric overflow occursCopyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/MatomoException.html b/javadoc/org/matomo/java/tracking/MatomoException.html new file mode 100644 index 00000000..d93a91e1 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/MatomoException.html @@ -0,0 +1,230 @@ + + + + + + +public class MatomoException +extends RuntimeException+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringCopyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/MatomoLocale.html b/javadoc/org/matomo/java/tracking/MatomoLocale.html new file mode 100644 index 00000000..3110a833 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/MatomoLocale.html @@ -0,0 +1,272 @@ + + + + + + +Country instead@Deprecated +public class MatomoLocale +extends Country+
| Constructor and Description | +
|---|
MatomoLocale(@NotNull Locale locale)
+Deprecated.
+
+Please use
+Country |
+
@Deprecated +public MatomoLocale(@NotNull + @NotNull Locale locale)+
Countrylocale - The locale to get the country code fromCopyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/MatomoRequest.html b/javadoc/org/matomo/java/tracking/MatomoRequest.html new file mode 100644 index 00000000..c4ed2247 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/MatomoRequest.html @@ -0,0 +1,758 @@ + + + + + + +public class MatomoRequest +extends Object+
MatomoTracker.| Constructor and Description | +
|---|
MatomoRequest(int siteId,
+ String actionUrl)
+Deprecated.
+
+Please use
+MatomoRequest#builder() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addCustomTrackingParameter(@NonNull String key,
+ @NonNull Object value)
+Add a custom tracking parameter to the specified key.
+ |
+
void |
+addEcommerceItem(@NonNull EcommerceItem item)
+Add an
+EcommerceItem to this order. |
+
void |
+clearCustomTrackingParameter()
+Removes all custom tracking parameters.
+ |
+
void |
+clearEcommerceItems()
+Clears all
+EcommerceItem from this order. |
+
void |
+enableEcommerce()
+Deprecated.
+
+Please use
+MatomoRequest#setGoalId(Integer) instead |
+
List<Object> |
+getCustomTrackingParameter(@NonNull String key)
+Gets the list of objects currently stored at the specified custom tracking
+ parameter.
+ |
+
@Nullable EcommerceItem |
+getEcommerceItem(int index)
+Get the
+EcommerceItem at the specified index. |
+
@Nullable CustomVariable |
+getPageCustomVariable(int index)
+Deprecated.
+
+Use
+MatomoRequest#getPageCustomVariables() instead |
+
@Nullable String |
+getPageCustomVariable(String key)
+Deprecated.
+
+Use the
+getPageCustomVariable(int) method instead. |
+
@Nullable MatomoDate |
+getRequestDatetime()
+Deprecated.
+
+Use
+#getRequestTimestamp() instead |
+
@Nullable String |
+getUserCustomVariable(String key)
+Deprecated.
+
+Use the
+getVisitCustomVariable(int) method instead. |
+
@Nullable CustomVariable |
+getVisitCustomVariable(int index)
+Deprecated.
+
+Use
+#getVisitCustomVariables() instead |
+
void |
+setCustomTrackingParameter(@NonNull String key,
+ @Nullable Object value)
+Set a custom tracking parameter whose toString() value will be sent to
+ the Matomo server.
+ |
+
void |
+setPageCustomVariable(@Nullable CustomVariable customVariable,
+ int index)
+Deprecated.
+
+Use
+#getPageCustomVariables() instead |
+
void |
+setPageCustomVariable(@NotNull String key,
+ @Nullable String value)
+Deprecated.
+
+Use
+MatomoRequest#getPageCustomVariables() instead |
+
void |
+setRequestDatetime(MatomoDate matomoDate)
+Deprecated.
+
+Use
+#setRequestTimestamp(Instant) instead |
+
void |
+setUserCustomVariable(@NotNull String key,
+ @Nullable String value)
+Deprecated.
+
+Use
+#setVisitCustomVariables(CustomVariables) instead |
+
void |
+setVisitCustomVariable(@Nullable CustomVariable customVariable,
+ int index)
+Deprecated.
+
+Use
+#setVisitCustomVariables(CustomVariables) instead |
+
@Deprecated +public MatomoRequest(int siteId, + String actionUrl)+
MatomoRequest#builder()
+
+ Required = true
+ Visior Id = random 16 character hex string
+ Random Value = random 20 character hex string
+ API version = 1
+ Response as Image = false
+
+
+ Overwrite these values yourself as desired.siteId - the id of the website we're tracking a visit/action foractionUrl - the full URL for the current actionpublic List<Object> getCustomTrackingParameter(@NonNull + @NonNull String key)+
key - the key of the parameter whose list of objects to get. Cannot be nullpublic void setCustomTrackingParameter(@NonNull + @NonNull String key, + @Nullable + @Nullable Object value)+
key - the parameter's key. Cannot be nullvalue - the parameter's value. Removes the parameter if nullpublic void addCustomTrackingParameter(@NonNull + @NonNull String key, + @NonNull + @NonNull Object value)+
key - the parameter's key. Cannot be nullvalue - the parameter's value. Cannot be nullpublic void clearCustomTrackingParameter()+
@Deprecated +public void enableEcommerce()+
MatomoRequest#setGoalId(Integer) instead@Nullable +public @Nullable EcommerceItem getEcommerceItem(int index)+
EcommerceItem at the specified index.index - the index of the EcommerceItem to returnEcommerceItem at the specified indexpublic void addEcommerceItem(@NonNull + @NonNull EcommerceItem item)+
EcommerceItem to this order. Ecommerce must be enabled,
+ and EcommerceId and EcommerceRevenue must first be set.item - the EcommerceItem to add. Cannot be nullpublic void clearEcommerceItems()+
EcommerceItem from this order.@Nullable + @Deprecated +public @Nullable String getPageCustomVariable(String key)+
getPageCustomVariable(int) method instead.key - the key of the variable to get@Deprecated + @Nullable +public @Nullable CustomVariable getPageCustomVariable(int index)+
MatomoRequest#getPageCustomVariables() insteadindex - the index of the variable to get. Must be greater than 0@Deprecated +public void setPageCustomVariable(@NotNull + @NotNull String key, + @Nullable + @Nullable String value)+
MatomoRequest#getPageCustomVariables() insteadkey - the key of the variable to setvalue - the value of the variable to set at the specified key. A null value will remove this custom variable@Deprecated +public void setPageCustomVariable(@Nullable + @Nullable CustomVariable customVariable, + int index)+
#getPageCustomVariables() insteadcustomVariable - the CustomVariable to set. A null value will remove the CustomVariable at the specified
+ indexindex - the index of he CustomVariable to set@Deprecated + @Nullable +public @Nullable MatomoDate getRequestDatetime()+
#getRequestTimestamp() instead@Deprecated +public void setRequestDatetime(MatomoDate matomoDate)+
#setRequestTimestamp(Instant) insteadmatomoDate - the datetime of the request to set. A null value will remove this parameter@Nullable + @Deprecated +public @Nullable String getUserCustomVariable(String key)+
getVisitCustomVariable(int) method instead.key - the key of the variable to get@Nullable + @Deprecated +public @Nullable CustomVariable getVisitCustomVariable(int index)+
#getVisitCustomVariables() insteadindex - the index of the variable to get@Deprecated +public void setUserCustomVariable(@NotNull + @NotNull String key, + @Nullable + @Nullable String value)+
#setVisitCustomVariables(CustomVariables) insteadkey - the key of the variable to setvalue - the value of the variable to set at the specified key. A null value will remove this parameter@Deprecated +public void setVisitCustomVariable(@Nullable + @Nullable CustomVariable customVariable, + int index)+
#setVisitCustomVariables(CustomVariables) insteadcustomVariable - the CustomVariable to set. A null value will remove the custom variable at the specified
+ indexindex - the index to set the customVariable at.Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/MatomoTracker.html b/javadoc/org/matomo/java/tracking/MatomoTracker.html new file mode 100644 index 00000000..3009aad5 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/MatomoTracker.html @@ -0,0 +1,647 @@ + + + + + + +public class MatomoTracker +extends Object+
MatomoRequests to a specified Matomo server.| Constructor and Description | +
|---|
MatomoTracker(@NotNull String hostUrl)
+Deprecated.
+
+Please use
+MatomoTracker(TrackerConfiguration) |
+
MatomoTracker(@NotNull String hostUrl,
+ int timeout)
+Deprecated.
+
+Please use
+MatomoTracker(TrackerConfiguration) |
+
MatomoTracker(@NotNull String hostUrl,
+ @Nullable String proxyHost,
+ int proxyPort)
+Deprecated.
+
+Please use
+MatomoTracker(TrackerConfiguration) |
+
MatomoTracker(@NotNull String hostUrl,
+ @Nullable String proxyHost,
+ int proxyPort,
+ int timeout)
+Deprecated.
+
+Please use
+MatomoTracker(TrackerConfiguration) |
+
MatomoTracker(@NotNull TrackerConfiguration trackerConfiguration)
+Creates a new Matomo Tracker instance.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+sendBulkRequest(@NonNull Iterable<? extends MatomoRequest> requests)
+Deprecated.
+
+use sendBulkRequestAsync instead
+ |
+
void |
+sendBulkRequest(@NonNull Iterable<? extends MatomoRequest> requests,
+ @Nullable String authToken)
+Deprecated.
+
+use sendBulkRequestAsync instead
+ |
+
CompletableFuture<Void> |
+sendBulkRequestAsync(@NotNull Iterable<? extends MatomoRequest> requests)
+Send multiple requests in a single HTTP call.
+ |
+
CompletableFuture<Void> |
+sendBulkRequestAsync(@NotNull Iterable<? extends MatomoRequest> requests,
+ @Nullable Consumer<Void> callback)
+Send multiple requests in a single HTTP call.
+ |
+
CompletableFuture<Void> |
+sendBulkRequestAsync(@NotNull Iterable<? extends MatomoRequest> requests,
+ @Nullable String authToken)
+Send multiple requests in a single HTTP call.
+ |
+
CompletableFuture<Void> |
+sendBulkRequestAsync(@NotNull Iterable<? extends MatomoRequest> requests,
+ @Nullable String authToken,
+ @Nullable Consumer<Void> callback)
+Send multiple requests in a single HTTP call.
+ |
+
void |
+sendRequest(@NonNull MatomoRequest request)
+Deprecated.
+
+use sendRequestAsync instead
+ |
+
CompletableFuture<Void> |
+sendRequestAsync(@NotNull MatomoRequest request)
+Send a request.
+ |
+
CompletableFuture<Void> |
+sendRequestAsync(@NotNull MatomoRequest request,
+ @Nullable Consumer<Void> callback)
+Send a request.
+ |
+
@Deprecated +public MatomoTracker(@NotNull + @NotNull String hostUrl)+
MatomoTracker(TrackerConfiguration)MatomoRequests to the specified
+ Tracking HTTP API endpoint.hostUrl - url endpoint to send requests to. Usually in the format
+ http://your-matomo-domain.tld/matomo.php. Must not be null@Deprecated +public MatomoTracker(@NotNull + @NotNull String hostUrl, + int timeout)+
MatomoTracker(TrackerConfiguration)MatomoRequests to the specified
+ Tracking HTTP API endpoint.hostUrl - url endpoint to send requests to. Usually in the format
+ http://your-matomo-domain.tld/matomo.php.timeout - the timeout of the sent request in milliseconds or -1 if not set@Deprecated +public MatomoTracker(@NotNull + @NotNull String hostUrl, + @Nullable + @Nullable String proxyHost, + int proxyPort, + int timeout)+
MatomoTracker(TrackerConfiguration)MatomoRequests to the specified
+ Tracking HTTP API endpoint.hostUrl - url endpoint to send requests to. Usually in the format
+ http://your-matomo-domain.tld/matomo.php.proxyHost - The hostname or IP address of an optional HTTP proxy, null allowedproxyPort - The port of an HTTP proxy or -1 if not settimeout - the timeout of the request in milliseconds or -1 if not setpublic MatomoTracker(@NotNull + @NotNull TrackerConfiguration trackerConfiguration)+
trackerConfiguration - Configurations parameters (you can use a builder)@Deprecated +public MatomoTracker(@NotNull + @NotNull String hostUrl, + @Nullable + @Nullable String proxyHost, + int proxyPort)+
MatomoTracker(TrackerConfiguration)MatomoRequests to the specified
+ Tracking HTTP API endpoint via the provided proxy.hostUrl - url endpoint to send requests to. Usually in the format
+ http://your-matomo-domain.tld/matomo.php.proxyHost - url endpoint for the proxy, null allowedproxyPort - proxy server port number or -1 if not set@Deprecated +public void sendRequest(@NonNull + @NonNull MatomoRequest request)+
request - request to send. must not be nullpublic CompletableFuture<Void> sendRequestAsync(@NotNull + @NotNull MatomoRequest request)+
request - request to sendpublic CompletableFuture<Void> sendRequestAsync(@NotNull + @NotNull MatomoRequest request, + @Nullable + @Nullable Consumer<Void> callback)+
request - request to sendcallback - callback that gets executed when response arrives, null allowed@Deprecated +public void sendBulkRequest(@NonNull + @NonNull Iterable<? extends MatomoRequest> requests)+
requests - the requests to send@Deprecated +public void sendBulkRequest(@NonNull + @NonNull Iterable<? extends MatomoRequest> requests, + @Nullable + @Nullable String authToken)+
requests - the requests to sendauthToken - specify if any of the parameters use require AuthToken, null allowedpublic CompletableFuture<Void> sendBulkRequestAsync(@NotNull + @NotNull Iterable<? extends MatomoRequest> requests)+
requests - the requests to sendpublic CompletableFuture<Void> sendBulkRequestAsync(@NotNull + @NotNull Iterable<? extends MatomoRequest> requests, + @Nullable + @Nullable String authToken, + @Nullable + @Nullable Consumer<Void> callback)+
requests - the requests to sendauthToken - specify if any of the parameters use require AuthToken, null allowedcallback - callback that gets executed when response arrives, null allowedpublic CompletableFuture<Void> sendBulkRequestAsync(@NotNull + @NotNull Iterable<? extends MatomoRequest> requests, + @Nullable + @Nullable Consumer<Void> callback)+
requests - the requests to sendcallback - callback that gets executed when response arrives, null allowedpublic CompletableFuture<Void> sendBulkRequestAsync(@NotNull + @NotNull Iterable<? extends MatomoRequest> requests, + @Nullable + @Nullable String authToken)+
requests - the requests to sendauthToken - specify if any of the parameters use require AuthToken, null allowedCopyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/TrackerConfiguration.html b/javadoc/org/matomo/java/tracking/TrackerConfiguration.html new file mode 100644 index 00000000..66a8c013 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/TrackerConfiguration.html @@ -0,0 +1,277 @@ + + + + + + +public class TrackerConfiguration +extends Object+
| Constructor and Description | +
|---|
TrackerConfiguration() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+validate()
+Validates the auth token.
+ |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/class-use/CustomVariable.html b/javadoc/org/matomo/java/tracking/class-use/CustomVariable.html new file mode 100644 index 00000000..adc76545 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/class-use/CustomVariable.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/class-use/EcommerceItem.html b/javadoc/org/matomo/java/tracking/class-use/EcommerceItem.html new file mode 100644 index 00000000..bb07429e --- /dev/null +++ b/javadoc/org/matomo/java/tracking/class-use/EcommerceItem.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/class-use/InvalidUrlException.html b/javadoc/org/matomo/java/tracking/class-use/InvalidUrlException.html new file mode 100644 index 00000000..8af39479 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/class-use/InvalidUrlException.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/class-use/MatomoDate.html b/javadoc/org/matomo/java/tracking/class-use/MatomoDate.html new file mode 100644 index 00000000..c15222c7 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/class-use/MatomoDate.html @@ -0,0 +1,218 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.matomo.java.tracking | +
+ This package contains classes that allow you to specify a
+MatomoTracker
+ with the corresponding TrackerConfiguration. |
+
| org.piwik.java.tracking | +
+ Piwik Java Tracking API.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
@Nullable MatomoDate |
+MatomoRequest.getRequestDatetime()
+Deprecated.
+
+Use
+#getRequestTimestamp() instead |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+MatomoRequest.setRequestDatetime(MatomoDate matomoDate)
+Deprecated.
+
+Use
+#setRequestTimestamp(Instant) instead |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+PiwikDate
+Deprecated.
+
+Please use
+Instant |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/class-use/MatomoException.html b/javadoc/org/matomo/java/tracking/class-use/MatomoException.html new file mode 100644 index 00000000..e4bc9a36 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/class-use/MatomoException.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/class-use/MatomoLocale.html b/javadoc/org/matomo/java/tracking/class-use/MatomoLocale.html new file mode 100644 index 00000000..e93a3c71 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/class-use/MatomoLocale.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/class-use/MatomoRequest.html b/javadoc/org/matomo/java/tracking/class-use/MatomoRequest.html new file mode 100644 index 00000000..446bcf1c --- /dev/null +++ b/javadoc/org/matomo/java/tracking/class-use/MatomoRequest.html @@ -0,0 +1,214 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.matomo.java.tracking | +
+ This package contains classes that allow you to specify a
+MatomoTracker
+ with the corresponding TrackerConfiguration. |
+
| org.piwik.java.tracking | +
+ Piwik Java Tracking API.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+MatomoTracker.sendRequest(@NonNull MatomoRequest request)
+Deprecated.
+
+use sendRequestAsync instead
+ |
+
CompletableFuture<Void> |
+MatomoTracker.sendRequestAsync(@NotNull MatomoRequest request)
+Send a request.
+ |
+
CompletableFuture<Void> |
+MatomoTracker.sendRequestAsync(@NotNull MatomoRequest request,
+ @Nullable Consumer<Void> callback)
+Send a request.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+PiwikRequest
+Deprecated.
+
+Use
+MatomoRequest instead. |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/class-use/MatomoTracker.html b/javadoc/org/matomo/java/tracking/class-use/MatomoTracker.html new file mode 100644 index 00000000..19afb75e --- /dev/null +++ b/javadoc/org/matomo/java/tracking/class-use/MatomoTracker.html @@ -0,0 +1,172 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.piwik.java.tracking | +
+ Piwik Java Tracking API.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+PiwikTracker
+Deprecated.
+
+Use
+MatomoTracker instead. |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/class-use/TrackerConfiguration.html b/javadoc/org/matomo/java/tracking/class-use/TrackerConfiguration.html new file mode 100644 index 00000000..ce4afcc8 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/class-use/TrackerConfiguration.html @@ -0,0 +1,169 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.matomo.java.tracking | +
+ This package contains classes that allow you to specify a
+MatomoTracker
+ with the corresponding TrackerConfiguration. |
+
| Constructor and Description | +
|---|
MatomoTracker(@NotNull TrackerConfiguration trackerConfiguration)
+Creates a new Matomo Tracker instance.
+ |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/package-frame.html b/javadoc/org/matomo/java/tracking/package-frame.html new file mode 100644 index 00000000..6d437377 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +MatomoTracker
+ with the corresponding TrackerConfiguration.See: Description
+| Class | +Description | +
|---|---|
| CustomVariable | +Deprecated
+ Use
+EcommerceItem instead. |
+
| EcommerceItem | +Deprecated
+ Use
+EcommerceItem instead. |
+
| MatomoDate | +Deprecated
+ Please use
+Instant |
+
| MatomoLocale | +Deprecated
+ Use
+Country instead |
+
| MatomoRequest | +
+ A class that implements the
+ Matomo Tracking HTTP API.
+ |
+
| MatomoTracker | +
+ A class that sends
+MatomoRequests to a specified Matomo server. |
+
| TrackerConfiguration | +
+ Defines configuration settings for the Matomo tracking.
+ |
+
| Exception | +Description | +
|---|---|
| InvalidUrlException | +
+ Thrown when an invalid URL is passed to the tracker.
+ |
+
| MatomoException | +
+ Thrown when an error occurs while communicating with the Matomo server or when the request is invalid.
+ |
+
MatomoTracker
+ with the corresponding TrackerConfiguration. You can then send a
+ MatomoRequest as a single HTTP GET request or multiple requests as a bulk HTTP POST
+ request synchronously or asynchronously. If an exception occurs, MatomoException
+ will be thrown.
+
+ For more information about the Matomo Tracking HTTP API, see the Matomo Tracking HTTP API.
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/package-tree.html b/javadoc/org/matomo/java/tracking/package-tree.html new file mode 100644 index 00000000..f23ced49 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/package-tree.html @@ -0,0 +1,171 @@ + + + + + + +Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/package-use.html b/javadoc/org/matomo/java/tracking/package-use.html new file mode 100644 index 00000000..3cb65f8e --- /dev/null +++ b/javadoc/org/matomo/java/tracking/package-use.html @@ -0,0 +1,213 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.matomo.java.tracking | +
+ This package contains classes that allow you to specify a
+MatomoTracker
+ with the corresponding TrackerConfiguration. |
+
| org.piwik.java.tracking | +
+ Piwik Java Tracking API.
+ |
+
| Class and Description | +
|---|
| MatomoDate
+ Deprecated.
+
+Please use
+Instant |
+
| MatomoRequest
+ A class that implements the
+ Matomo Tracking HTTP API.
+ |
+
| TrackerConfiguration
+ Defines configuration settings for the Matomo tracking.
+ |
+
| Class and Description | +
|---|
| MatomoDate
+ Deprecated.
+
+Please use
+Instant |
+
| MatomoRequest
+ A class that implements the
+ Matomo Tracking HTTP API.
+ |
+
| MatomoTracker
+ A class that sends
+MatomoRequests to a specified Matomo server. |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/AcceptLanguage.html b/javadoc/org/matomo/java/tracking/parameters/AcceptLanguage.html new file mode 100644 index 00000000..59d4f216 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/AcceptLanguage.html @@ -0,0 +1,315 @@ + + + + + + +public class AcceptLanguage +extends Object+
Example: "en-US,en;q=0.8,de;q=0.6"
| Constructor and Description | +
|---|
AcceptLanguage() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static @Nullable AcceptLanguage |
+fromHeader(@Nullable String header)
+Creates the Accept-Language definition for a given header.
+ |
+
@NotNull String |
+toString()
+Returns the Accept Language header value.
+ |
+
@Nullable +public static @Nullable AcceptLanguage fromHeader(@Nullable + @Nullable String header)+
Please see Locale.LanguageRange.parse(String) for more information. Example: "en-US,en;q=0.8,de;q=0.6"
header - A header that can be nullLocale.LanguageRange.parse(String)Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/Country.html b/javadoc/org/matomo/java/tracking/parameters/Country.html new file mode 100644 index 00000000..3a936e61 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/Country.html @@ -0,0 +1,399 @@ + + + + + + +public class Country +extends Object+
See ISO 3166-1 alpha-2 for a list of valid codes.
| Modifier | +Constructor and Description | +
|---|---|
protected |
+Country(@NotNull Locale locale)
+Deprecated.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static @Nullable Country |
+fromCode(@Nullable String code)
+Creates a country from a given code.
+ |
+
static @Nullable Country |
+fromLanguageRanges(@Nullable String ranges)
+Extracts the country from the given accept language header.
+ |
+
Locale |
+getLocale()
+Deprecated.
+
+Since you instantiate this class, you can determine the language on your own
+ using
+Locale.forLanguageTag(String) |
+
void |
+setLocale(Locale locale)
+Deprecated.
+
+Since you instantiate this class, you can determine the language on your own
+ using
+Locale.getCountry() |
+
String |
+toString() |
+
@Deprecated +protected Country(@NotNull + @NotNull Locale locale)+
MatomoLocale.locale - A locale that must contain a country code@Nullable +public static @Nullable Country fromCode(@Nullable + @Nullable String code)+
code - Must consist of two lower letters or simply null. Case is ignored@Nullable +public static @Nullable Country fromLanguageRanges(@Nullable + @Nullable String ranges)+
ranges - A language range list. See Locale.LanguageRange.parse(String)@Deprecated +public Locale getLocale()+
Locale.forLanguageTag(String)Locale.forLanguageTag(String)public final void setLocale(Locale locale)+
Locale.getCountry()locale - A locale that must contain a country codeLocale.getCountry()Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/CustomVariable.html b/javadoc/org/matomo/java/tracking/parameters/CustomVariable.html new file mode 100644 index 00000000..b117f750 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/CustomVariable.html @@ -0,0 +1,268 @@ + + + + + + +@Deprecated +public class CustomVariable +extends Object+
If you are not already using Custom Variables to measure your custom data, Matomo recommends to use the + Custom Dimensions feature instead. + There are many advantages of Custom Dimensions over Custom + variables. Custom variables will be deprecated in the future.
| Constructor and Description | +
|---|
CustomVariable(@NonNull String key,
+ @NonNull String value)
+Deprecated.
+Instantiates a new custom variable.
+ |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/CustomVariables.html b/javadoc/org/matomo/java/tracking/parameters/CustomVariables.html new file mode 100644 index 00000000..cff499cd --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/CustomVariables.html @@ -0,0 +1,443 @@ + + + + + + +@Deprecated +public class CustomVariables +extends Object+
| Constructor and Description | +
|---|
CustomVariables()
+Deprecated.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
CustomVariables |
+add(@NonNull CustomVariable variable)
+Deprecated.
+Adds a custom variable to the list with the next available index.
+ |
+
CustomVariables |
+add(@NonNull CustomVariable cv,
+ int index)
+Deprecated.
+Adds a custom variable to the list with the given index.
+ |
+
@Nullable CustomVariable |
+get(int index)
+Deprecated.
+Returns the custom variable at the given index.
+ |
+
@Nullable String |
+get(@NonNull String key)
+Deprecated.
+Returns the value of the custom variable with the given key.
+ |
+
void |
+remove(int index)
+Deprecated.
+Removes the custom variable at the given index.
+ |
+
void |
+remove(@NonNull String key)
+Deprecated.
+Removes the custom variable with the given key.
+ |
+
String |
+toString()
+Deprecated.
+Creates a JSON representation of the custom variables.
+ |
+
public CustomVariables add(@NonNull + @NonNull CustomVariable variable)+
variable - The custom variable to addpublic CustomVariables add(@NonNull + @NonNull CustomVariable cv, + int index)+
cv - The custom variable to addindex - The index to add the custom variable at@Nullable +public @Nullable CustomVariable get(int index)+
index - The index of the custom variable@Nullable +public @Nullable String get(@NonNull + @NonNull String key)+
key - The key of the custom variable. Must not be null.public void remove(int index)+
index - The index of the custom variable to remove. Must be greater than 0.public void remove(@NonNull + @NonNull String key)+
key - The key of the custom variable to remove. Must not be null.Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/DeviceResolution.html b/javadoc/org/matomo/java/tracking/parameters/DeviceResolution.html new file mode 100644 index 00000000..e3c6088b --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/DeviceResolution.html @@ -0,0 +1,304 @@ + + + + + + +public class DeviceResolution +extends Object+
| Constructor and Description | +
|---|
DeviceResolution() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static @Nullable DeviceResolution |
+fromString(@Nullable String deviceResolution)
+Creates a device resolution from a string representation.
+ |
+
String |
+toString() |
+
@Nullable +public static @Nullable DeviceResolution fromString(@Nullable + @Nullable String deviceResolution)+
The string must be in the format "widthxheight", e.g. "1920x1080".
deviceResolution - The string representation of the device resolution, e.g. "1920x1080"Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/EcommerceItem.html b/javadoc/org/matomo/java/tracking/parameters/EcommerceItem.html new file mode 100644 index 00000000..e5868854 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/EcommerceItem.html @@ -0,0 +1,282 @@ + + + + + + +public class EcommerceItem +extends Object+
| Constructor and Description | +
|---|
EcommerceItem() |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/EcommerceItems.html b/javadoc/org/matomo/java/tracking/parameters/EcommerceItems.html new file mode 100644 index 00000000..548b0894 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/EcommerceItems.html @@ -0,0 +1,278 @@ + + + + + + +public class EcommerceItems +extends Object+
| Constructor and Description | +
|---|
EcommerceItems() |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/RandomValue.html b/javadoc/org/matomo/java/tracking/parameters/RandomValue.html new file mode 100644 index 00000000..5e75e7ba --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/RandomValue.html @@ -0,0 +1,320 @@ + + + + + + +public class RandomValue +extends Object+
| Constructor and Description | +
|---|
RandomValue() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static RandomValue |
+fromString(String override)
+Static factory to generate a random value from a given string.
+ |
+
static RandomValue |
+random()
+Static factory to generate a random value.
+ |
+
String |
+toString() |
+
public static RandomValue random()+
public static RandomValue fromString(String override)+
override - The string to use as random valueCopyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/UniqueId.html b/javadoc/org/matomo/java/tracking/parameters/UniqueId.html new file mode 100644 index 00000000..f4d7a8c0 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/UniqueId.html @@ -0,0 +1,320 @@ + + + + + + +public final class UniqueId +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static UniqueId |
+fromValue(long value)
+Creates a unique id from a number.
+ |
+
static UniqueId |
+random()
+Static factory to generate a random unique id.
+ |
+
String |
+toString() |
+
public static UniqueId random()+
public static UniqueId fromValue(long value)+
value - A number to create this unique id fromCopyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/VisitorId.html b/javadoc/org/matomo/java/tracking/parameters/VisitorId.html new file mode 100644 index 00000000..150df1c2 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/VisitorId.html @@ -0,0 +1,353 @@ + + + + + + +public class VisitorId +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static VisitorId |
+fromHash(long hash)
+Creates always the same visitor id for the given input.
+ |
+
static VisitorId |
+fromHex(String inputHex)
+Creates a visitor id from a hexadecimal string.
+ |
+
static VisitorId |
+random()
+Static factory to generate a random visitor id.
+ |
+
String |
+toString() |
+
public static VisitorId random()+
Please consider creating a fixed id for each visitor by getting a hash code from e.g. the username and
+ using fromHash(long)
public static VisitorId fromHash(long hash)+
You can use e.g. Object.hashCode() to generate a hash code for an object, e.g. a username
+ string as input.
hash - A number (e.g. a hash code) to create the visitor id frompublic static VisitorId fromHex(String inputHex)+
The input must be a valid hexadecimal string with a maximum length of 16 characters. If the input is shorter + than 16 characters it will be padded with zeros.
inputHex - A hexadecimal string to create the visitor id fromCopyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/class-use/AcceptLanguage.html b/javadoc/org/matomo/java/tracking/parameters/class-use/AcceptLanguage.html new file mode 100644 index 00000000..25c3fc13 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/class-use/AcceptLanguage.html @@ -0,0 +1,171 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.matomo.java.tracking.parameters | +
+ Contains types for Matomo Tracking Parameters according to
+ the Matomo Tracking HTTP API.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static @Nullable AcceptLanguage |
+AcceptLanguage.fromHeader(@Nullable String header)
+Creates the Accept-Language definition for a given header.
+ |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/class-use/Country.html b/javadoc/org/matomo/java/tracking/parameters/class-use/Country.html new file mode 100644 index 00000000..9c36401e --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/class-use/Country.html @@ -0,0 +1,234 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.matomo.java.tracking | +
+ This package contains classes that allow you to specify a
+MatomoTracker
+ with the corresponding TrackerConfiguration. |
+
| org.matomo.java.tracking.parameters | +
+ Contains types for Matomo Tracking Parameters according to
+ the Matomo Tracking HTTP API.
+ |
+
| org.piwik.java.tracking | +
+ Piwik Java Tracking API.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+MatomoLocale
+Deprecated.
+
+Use
+Country instead |
+
| Modifier and Type | +Method and Description | +
|---|---|
static @Nullable Country |
+Country.fromCode(@Nullable String code)
+Creates a country from a given code.
+ |
+
static @Nullable Country |
+Country.fromLanguageRanges(@Nullable String ranges)
+Extracts the country from the given accept language header.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+PiwikLocale
+Deprecated.
+
+Use
+Country instead. |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/class-use/CustomVariable.html b/javadoc/org/matomo/java/tracking/parameters/class-use/CustomVariable.html new file mode 100644 index 00000000..dcc93a17 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/class-use/CustomVariable.html @@ -0,0 +1,277 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.matomo.java.tracking | +
+ This package contains classes that allow you to specify a
+MatomoTracker
+ with the corresponding TrackerConfiguration. |
+
| org.matomo.java.tracking.parameters | +
+ Contains types for Matomo Tracking Parameters according to
+ the Matomo Tracking HTTP API.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+CustomVariable
+Deprecated.
+
+Use
+EcommerceItem instead. |
+
| Modifier and Type | +Method and Description | +
|---|---|
@Nullable CustomVariable |
+MatomoRequest.getPageCustomVariable(int index)
+Deprecated.
+
+Use
+MatomoRequest#getPageCustomVariables() instead |
+
@Nullable CustomVariable |
+MatomoRequest.getVisitCustomVariable(int index)
+Deprecated.
+
+Use
+#getVisitCustomVariables() instead |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+MatomoRequest.setPageCustomVariable(@Nullable CustomVariable customVariable,
+ int index)
+Deprecated.
+
+Use
+#getPageCustomVariables() instead |
+
void |
+MatomoRequest.setVisitCustomVariable(@Nullable CustomVariable customVariable,
+ int index)
+Deprecated.
+
+Use
+#setVisitCustomVariables(CustomVariables) instead |
+
| Modifier and Type | +Method and Description | +
|---|---|
@Nullable CustomVariable |
+CustomVariables.get(int index)
+Deprecated.
+Returns the custom variable at the given index.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
CustomVariables |
+CustomVariables.add(@NonNull CustomVariable variable)
+Deprecated.
+Adds a custom variable to the list with the next available index.
+ |
+
CustomVariables |
+CustomVariables.add(@NonNull CustomVariable cv,
+ int index)
+Deprecated.
+Adds a custom variable to the list with the given index.
+ |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/class-use/CustomVariables.html b/javadoc/org/matomo/java/tracking/parameters/class-use/CustomVariables.html new file mode 100644 index 00000000..4bb246f1 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/class-use/CustomVariables.html @@ -0,0 +1,180 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.matomo.java.tracking.parameters | +
+ Contains types for Matomo Tracking Parameters according to
+ the Matomo Tracking HTTP API.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
CustomVariables |
+CustomVariables.add(@NonNull CustomVariable variable)
+Deprecated.
+Adds a custom variable to the list with the next available index.
+ |
+
CustomVariables |
+CustomVariables.add(@NonNull CustomVariable cv,
+ int index)
+Deprecated.
+Adds a custom variable to the list with the given index.
+ |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/class-use/DeviceResolution.html b/javadoc/org/matomo/java/tracking/parameters/class-use/DeviceResolution.html new file mode 100644 index 00000000..8aa0038e --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/class-use/DeviceResolution.html @@ -0,0 +1,171 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.matomo.java.tracking.parameters | +
+ Contains types for Matomo Tracking Parameters according to
+ the Matomo Tracking HTTP API.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static @Nullable DeviceResolution |
+DeviceResolution.fromString(@Nullable String deviceResolution)
+Creates a device resolution from a string representation.
+ |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/class-use/EcommerceItem.html b/javadoc/org/matomo/java/tracking/parameters/class-use/EcommerceItem.html new file mode 100644 index 00000000..7fa34d2b --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/class-use/EcommerceItem.html @@ -0,0 +1,203 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.matomo.java.tracking | +
+ This package contains classes that allow you to specify a
+MatomoTracker
+ with the corresponding TrackerConfiguration. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+EcommerceItem
+Deprecated.
+
+Use
+EcommerceItem instead. |
+
| Modifier and Type | +Method and Description | +
|---|---|
@Nullable EcommerceItem |
+MatomoRequest.getEcommerceItem(int index)
+Get the
+EcommerceItem at the specified index. |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+MatomoRequest.addEcommerceItem(@NonNull EcommerceItem item)
+Add an
+EcommerceItem to this order. |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/class-use/EcommerceItems.html b/javadoc/org/matomo/java/tracking/parameters/class-use/EcommerceItems.html new file mode 100644 index 00000000..2707fdd7 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/class-use/EcommerceItems.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/class-use/RandomValue.html b/javadoc/org/matomo/java/tracking/parameters/class-use/RandomValue.html new file mode 100644 index 00000000..69819bee --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/class-use/RandomValue.html @@ -0,0 +1,177 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.matomo.java.tracking.parameters | +
+ Contains types for Matomo Tracking Parameters according to
+ the Matomo Tracking HTTP API.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static RandomValue |
+RandomValue.fromString(String override)
+Static factory to generate a random value from a given string.
+ |
+
static RandomValue |
+RandomValue.random()
+Static factory to generate a random value.
+ |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/class-use/UniqueId.html b/javadoc/org/matomo/java/tracking/parameters/class-use/UniqueId.html new file mode 100644 index 00000000..dc657947 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/class-use/UniqueId.html @@ -0,0 +1,177 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.matomo.java.tracking.parameters | +
+ Contains types for Matomo Tracking Parameters according to
+ the Matomo Tracking HTTP API.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static UniqueId |
+UniqueId.fromValue(long value)
+Creates a unique id from a number.
+ |
+
static UniqueId |
+UniqueId.random()
+Static factory to generate a random unique id.
+ |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/class-use/VisitorId.html b/javadoc/org/matomo/java/tracking/parameters/class-use/VisitorId.html new file mode 100644 index 00000000..62cd1307 --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/class-use/VisitorId.html @@ -0,0 +1,183 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.matomo.java.tracking.parameters | +
+ Contains types for Matomo Tracking Parameters according to
+ the Matomo Tracking HTTP API.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static VisitorId |
+VisitorId.fromHash(long hash)
+Creates always the same visitor id for the given input.
+ |
+
static VisitorId |
+VisitorId.fromHex(String inputHex)
+Creates a visitor id from a hexadecimal string.
+ |
+
static VisitorId |
+VisitorId.random()
+Static factory to generate a random visitor id.
+ |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/package-frame.html b/javadoc/org/matomo/java/tracking/parameters/package-frame.html new file mode 100644 index 00000000..e69c954b --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/package-frame.html @@ -0,0 +1,30 @@ + + + + + + +See: Description
+| Class | +Description | +
|---|---|
| AcceptLanguage | +
+ Describes the content for the Accept-Language header field that can be overridden by a custom parameter.
+ |
+
| Country | +
+ A two-letter country code representing a country.
+ |
+
| CustomVariable | +Deprecated
+ Should not be used according to the Matomo FAQ: How do I use Custom Variables?
+ |
+
| CustomVariables | +Deprecated
+ Should not be used according to the Matomo FAQ: How do I use Custom Variables?
+ |
+
| DeviceResolution | +
+ The resolution (width and height) of the user's output device (monitor / phone).
+ |
+
| EcommerceItem | +
+ Represents an item in an ecommerce order.
+ |
+
| EcommerceItems | +
+ Multiple things that you can buy online.
+ |
+
| RandomValue | +
+ A random value to avoid the tracking request being cached by the browser or a proxy.
+ |
+
| UniqueId | +
+ A six character unique ID consisting of the characters [0-9a-Z].
+ |
+
| VisitorId | +
+ The unique visitor ID, must be a 16 characters hexadecimal string.
+ |
+
The types help you to use the correct format for the tracking parameters. The package was introduced in Matomo + Java Tracker version 3 to let the tracker be more self-explanatory and better maintainable.
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/package-tree.html b/javadoc/org/matomo/java/tracking/parameters/package-tree.html new file mode 100644 index 00000000..07373a6b --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/package-tree.html @@ -0,0 +1,148 @@ + + + + + + +Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/matomo/java/tracking/parameters/package-use.html b/javadoc/org/matomo/java/tracking/parameters/package-use.html new file mode 100644 index 00000000..8ffe997e --- /dev/null +++ b/javadoc/org/matomo/java/tracking/parameters/package-use.html @@ -0,0 +1,262 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.matomo.java.tracking | +
+ This package contains classes that allow you to specify a
+MatomoTracker
+ with the corresponding TrackerConfiguration. |
+
| org.matomo.java.tracking.parameters | +
+ Contains types for Matomo Tracking Parameters according to
+ the Matomo Tracking HTTP API.
+ |
+
| org.piwik.java.tracking | +
+ Piwik Java Tracking API.
+ |
+
| Class and Description | +
|---|
| Country
+ A two-letter country code representing a country.
+ |
+
| CustomVariable
+ Deprecated.
+
+Should not be used according to the Matomo FAQ: How do I use Custom Variables?
+ |
+
| EcommerceItem
+ Represents an item in an ecommerce order.
+ |
+
| Class and Description | +
|---|
| AcceptLanguage
+ Describes the content for the Accept-Language header field that can be overridden by a custom parameter.
+ |
+
| Country
+ A two-letter country code representing a country.
+ |
+
| CustomVariable
+ Deprecated.
+
+Should not be used according to the Matomo FAQ: How do I use Custom Variables?
+ |
+
| CustomVariables
+ Deprecated.
+
+Should not be used according to the Matomo FAQ: How do I use Custom Variables?
+ |
+
| DeviceResolution
+ The resolution (width and height) of the user's output device (monitor / phone).
+ |
+
| RandomValue
+ A random value to avoid the tracking request being cached by the browser or a proxy.
+ |
+
| UniqueId
+ A six character unique ID consisting of the characters [0-9a-Z].
+ |
+
| VisitorId
+ The unique visitor ID, must be a 16 characters hexadecimal string.
+ |
+
| Class and Description | +
|---|
| Country
+ A two-letter country code representing a country.
+ |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/piwik/java/tracking/CustomVariable.html b/javadoc/org/piwik/java/tracking/CustomVariable.html new file mode 100644 index 00000000..4a2aed62 --- /dev/null +++ b/javadoc/org/piwik/java/tracking/CustomVariable.html @@ -0,0 +1,269 @@ + + + + + + +CustomVariable instead.@Deprecated +public class CustomVariable +extends CustomVariable+
Renamed to CustomVariable in 3.0.0.
| Constructor and Description | +
|---|
CustomVariable(String key,
+ String value)
+Deprecated.
+
+Use
+CustomVariable instead. |
+
@Deprecated +public CustomVariable(String key, + String value)+
CustomVariable instead.key - the key of the custom variable (required)value - the value of the custom variable (required)Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/piwik/java/tracking/EcommerceItem.html b/javadoc/org/piwik/java/tracking/EcommerceItem.html new file mode 100644 index 00000000..f02d4aee --- /dev/null +++ b/javadoc/org/piwik/java/tracking/EcommerceItem.html @@ -0,0 +1,283 @@ + + + + + + +EcommerceItem instead.@Deprecated +public class EcommerceItem +extends EcommerceItem+
| Constructor and Description | +
|---|
EcommerceItem(String sku,
+ String name,
+ String category,
+ Double price,
+ Integer quantity)
+Deprecated.
+
+Use
+EcommerceItem instead. |
+
@Deprecated +public EcommerceItem(String sku, + String name, + String category, + Double price, + Integer quantity)+
EcommerceItem instead.sku - the sku (Stock Keeping Unit) of the item.name - the name of the item.category - the category of the item.price - the price of the item.quantity - the quantity of the item.Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/piwik/java/tracking/PiwikDate.html b/javadoc/org/piwik/java/tracking/PiwikDate.html new file mode 100644 index 00000000..cffc8ec6 --- /dev/null +++ b/javadoc/org/piwik/java/tracking/PiwikDate.html @@ -0,0 +1,333 @@ + + + + + + +Instant@Deprecated +public class PiwikDate +extends MatomoDate+
| Constructor and Description | +
|---|
PiwikDate()
+Deprecated.
+
+Use
+Instant instead. |
+
PiwikDate(long epochMilli)
+Deprecated.
+
+Use
+Instant instead. |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+setTimeZone(TimeZone zone)
+Deprecated.
+
+Use
+ChronoZonedDateTime.toInstant() instead. |
+
getTime, setTimeZonepublic PiwikDate()+
Instant instead.public PiwikDate(long epochMilli)+
Instant instead.epochMilli - The time in milliseconds since the epoch@Deprecated +public void setTimeZone(TimeZone zone)+
ChronoZonedDateTime.toInstant() instead.zone - the time zone to useCopyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/piwik/java/tracking/PiwikLocale.html b/javadoc/org/piwik/java/tracking/PiwikLocale.html new file mode 100644 index 00000000..1a8a612f --- /dev/null +++ b/javadoc/org/piwik/java/tracking/PiwikLocale.html @@ -0,0 +1,272 @@ + + + + + + +Country instead.@Deprecated +public class PiwikLocale +extends Country+
| Constructor and Description | +
|---|
PiwikLocale(Locale locale)
+Deprecated.
+
+Use
+Country instead. |
+
@Deprecated +public PiwikLocale(Locale locale)+
Country instead.locale - the locale to useCopyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/piwik/java/tracking/PiwikRequest.html b/javadoc/org/piwik/java/tracking/PiwikRequest.html new file mode 100644 index 00000000..5d28c2c3 --- /dev/null +++ b/javadoc/org/piwik/java/tracking/PiwikRequest.html @@ -0,0 +1,275 @@ + + + + + + +MatomoRequest instead.@Deprecated +public class PiwikRequest +extends MatomoRequest+
| Constructor and Description | +
|---|
PiwikRequest(int siteId,
+ URL actionUrl)
+Deprecated.
+
+Use
+MatomoRequest instead. |
+
addCustomTrackingParameter, addEcommerceItem, clearCustomTrackingParameter, clearEcommerceItems, enableEcommerce, getCustomTrackingParameter, getEcommerceItem, getPageCustomVariable, getPageCustomVariable, getRequestDatetime, getUserCustomVariable, getVisitCustomVariable, setCustomTrackingParameter, setPageCustomVariable, setPageCustomVariable, setRequestDatetime, setUserCustomVariable, setVisitCustomVariable@Deprecated +public PiwikRequest(int siteId, + URL actionUrl)+
MatomoRequest instead.siteId - the site IDactionUrl - the action URL. Must not be null.Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/piwik/java/tracking/PiwikTracker.html b/javadoc/org/piwik/java/tracking/PiwikTracker.html new file mode 100644 index 00000000..a0ff8f99 --- /dev/null +++ b/javadoc/org/piwik/java/tracking/PiwikTracker.html @@ -0,0 +1,359 @@ + + + + + + +MatomoTracker instead.@Deprecated +public class PiwikTracker +extends MatomoTracker+
| Constructor and Description | +
|---|
PiwikTracker(String hostUrl)
+Deprecated.
+
+Use
+MatomoTracker instead. |
+
PiwikTracker(String hostUrl,
+ int timeout)
+Deprecated.
+
+Use
+MatomoTracker instead. |
+
PiwikTracker(String hostUrl,
+ String proxyHost,
+ int proxyPort)
+Deprecated.
+
+Use
+MatomoTracker instead. |
+
PiwikTracker(String hostUrl,
+ String proxyHost,
+ int proxyPort,
+ int timeout)
+Deprecated.
+
+Use
+MatomoTracker instead. |
+
sendBulkRequest, sendBulkRequest, sendBulkRequestAsync, sendBulkRequestAsync, sendBulkRequestAsync, sendBulkRequestAsync, sendRequest, sendRequestAsync, sendRequestAsync@Deprecated +public PiwikTracker(String hostUrl)+
MatomoTracker instead.hostUrl - the host URL of the Matomo server@Deprecated +public PiwikTracker(String hostUrl, + int timeout)+
MatomoTracker instead.hostUrl - the host URL of the Matomo servertimeout - the timeout in milliseconds or -1 for no timeout@Deprecated +public PiwikTracker(String hostUrl, + String proxyHost, + int proxyPort)+
MatomoTracker instead.hostUrl - the host URL of the Matomo serverproxyHost - the proxy hostproxyPort - the proxy port@Deprecated +public PiwikTracker(String hostUrl, + String proxyHost, + int proxyPort, + int timeout)+
MatomoTracker instead.hostUrl - the host URL of the Matomo serverproxyHost - the proxy hostproxyPort - the proxy porttimeout - the timeout in milliseconds or -1 for no timeoutCopyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/piwik/java/tracking/class-use/CustomVariable.html b/javadoc/org/piwik/java/tracking/class-use/CustomVariable.html new file mode 100644 index 00000000..cac09c9b --- /dev/null +++ b/javadoc/org/piwik/java/tracking/class-use/CustomVariable.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/piwik/java/tracking/class-use/EcommerceItem.html b/javadoc/org/piwik/java/tracking/class-use/EcommerceItem.html new file mode 100644 index 00000000..81401b41 --- /dev/null +++ b/javadoc/org/piwik/java/tracking/class-use/EcommerceItem.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/piwik/java/tracking/class-use/PiwikDate.html b/javadoc/org/piwik/java/tracking/class-use/PiwikDate.html new file mode 100644 index 00000000..ec45a920 --- /dev/null +++ b/javadoc/org/piwik/java/tracking/class-use/PiwikDate.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/piwik/java/tracking/class-use/PiwikLocale.html b/javadoc/org/piwik/java/tracking/class-use/PiwikLocale.html new file mode 100644 index 00000000..3e35c7cc --- /dev/null +++ b/javadoc/org/piwik/java/tracking/class-use/PiwikLocale.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/piwik/java/tracking/class-use/PiwikRequest.html b/javadoc/org/piwik/java/tracking/class-use/PiwikRequest.html new file mode 100644 index 00000000..cb13b004 --- /dev/null +++ b/javadoc/org/piwik/java/tracking/class-use/PiwikRequest.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/piwik/java/tracking/class-use/PiwikTracker.html b/javadoc/org/piwik/java/tracking/class-use/PiwikTracker.html new file mode 100644 index 00000000..73374f74 --- /dev/null +++ b/javadoc/org/piwik/java/tracking/class-use/PiwikTracker.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/piwik/java/tracking/package-frame.html b/javadoc/org/piwik/java/tracking/package-frame.html new file mode 100644 index 00000000..4e94357a --- /dev/null +++ b/javadoc/org/piwik/java/tracking/package-frame.html @@ -0,0 +1,26 @@ + + + + + + +| Class | +Description | +
|---|---|
| CustomVariable | +Deprecated
+ Use
+CustomVariable instead. |
+
| EcommerceItem | +Deprecated
+ Use
+EcommerceItem instead. |
+
| PiwikDate | +Deprecated
+ Please use
+Instant |
+
| PiwikLocale | +Deprecated
+ Use
+Country instead. |
+
| PiwikRequest | +Deprecated
+ Use
+MatomoRequest instead. |
+
| PiwikTracker | +Deprecated
+ Use
+MatomoTracker instead. |
+
org.matomo.java.tracking in 3.0.0.Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/piwik/java/tracking/package-tree.html b/javadoc/org/piwik/java/tracking/package-tree.html new file mode 100644 index 00000000..07c0fb97 --- /dev/null +++ b/javadoc/org/piwik/java/tracking/package-tree.html @@ -0,0 +1,168 @@ + + + + + + +Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/org/piwik/java/tracking/package-use.html b/javadoc/org/piwik/java/tracking/package-use.html new file mode 100644 index 00000000..60c7e6af --- /dev/null +++ b/javadoc/org/piwik/java/tracking/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/overview-frame.html b/javadoc/overview-frame.html new file mode 100644 index 00000000..aa46b33f --- /dev/null +++ b/javadoc/overview-frame.html @@ -0,0 +1,24 @@ + + + + + + ++ + diff --git a/javadoc/overview-summary.html b/javadoc/overview-summary.html new file mode 100644 index 00000000..33583711 --- /dev/null +++ b/javadoc/overview-summary.html @@ -0,0 +1,156 @@ + + + + + + +
| Package | +Description | +
|---|---|
| org.matomo.java.tracking | +
+ This package contains classes that allow you to specify a
+MatomoTracker
+ with the corresponding TrackerConfiguration. |
+
| org.matomo.java.tracking.parameters | +
+ Contains types for Matomo Tracking Parameters according to
+ the Matomo Tracking HTTP API.
+ |
+
| org.piwik.java.tracking | +
+ Piwik Java Tracking API.
+ |
+
Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/overview-tree.html b/javadoc/overview-tree.html new file mode 100644 index 00000000..3ce7c343 --- /dev/null +++ b/javadoc/overview-tree.html @@ -0,0 +1,195 @@ + + + + + + +Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/package-list b/javadoc/package-list new file mode 100644 index 00000000..c6dc0a8d --- /dev/null +++ b/javadoc/package-list @@ -0,0 +1,3 @@ +org.matomo.java.tracking +org.matomo.java.tracking.parameters +org.piwik.java.tracking diff --git a/javadoc/script.js b/javadoc/script.js new file mode 100644 index 00000000..b3463569 --- /dev/null +++ b/javadoc/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/javadoc/serialized-form.html b/javadoc/serialized-form.html new file mode 100644 index 00000000..7eb3e9f1 --- /dev/null +++ b/javadoc/serialized-form.html @@ -0,0 +1,148 @@ + + + + + + +Copyright © 2023. All rights reserved.
+ + diff --git a/javadoc/stylesheet.css b/javadoc/stylesheet.css new file mode 100644 index 00000000..98055b22 --- /dev/null +++ b/javadoc/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +}