From ec1c77243122c664d067594d1f4ed0d03a7aa417 Mon Sep 17 00:00:00 2001 From: Elijah Melton Date: Sun, 3 Nov 2024 18:38:36 -0800 Subject: [PATCH] javadoc --- docs/META-INF/MANIFEST.MF | 4 + docs/allclasses-index.html | 126 ++ docs/allpackages-index.html | 77 + docs/constant-values.html | 90 ++ docs/copy.svg | 33 + docs/element-list | 5 + docs/help-doc.html | 203 +++ docs/index-all.html | 450 ++++++ docs/index.html | 79 + .../github/elimelt/pmqueue/MessageQueue.html | 218 +++ .../elimelt/pmqueue/QueueConfig.Builder.html | 337 +++++ .../github/elimelt/pmqueue/QueueConfig.html | 303 ++++ .../QueueFactory.CustomQueueBuilder.html | 332 +++++ .../pmqueue/QueueFactory.QueuePreset.html | 279 ++++ .../github/elimelt/pmqueue/QueueFactory.html | 361 +++++ .../pmqueue/class-use/MessageQueue.html | 182 +++ .../class-use/QueueConfig.Builder.html | 124 ++ .../pmqueue/class-use/QueueConfig.html | 107 ++ .../QueueFactory.CustomQueueBuilder.html | 119 ++ .../class-use/QueueFactory.QueuePreset.html | 95 ++ .../pmqueue/class-use/QueueFactory.html | 62 + .../consumer/DefaultMessageConsumer.html | 287 ++++ .../pmqueue/consumer/MessageConsumer.html | 190 +++ .../class-use/DefaultMessageConsumer.html | 62 + .../consumer/class-use/MessageConsumer.html | 89 ++ .../pmqueue/consumer/package-summary.html | 121 ++ .../pmqueue/consumer/package-tree.html | 86 ++ .../elimelt/pmqueue/consumer/package-use.html | 86 ++ .../pmqueue/core/PersistentMessageQueue.html | 490 +++++++ .../class-use/PersistentMessageQueue.html | 62 + .../elimelt/pmqueue/core/package-summary.html | 116 ++ .../elimelt/pmqueue/core/package-tree.html | 76 + .../elimelt/pmqueue/core/package-use.html | 62 + .../pmqueue/impl/AutoFlushingQueue.html | 282 ++++ .../elimelt/pmqueue/impl/ValidatingQueue.html | 278 ++++ .../impl/class-use/AutoFlushingQueue.html | 62 + .../impl/class-use/ValidatingQueue.html | 62 + .../elimelt/pmqueue/impl/package-summary.html | 121 ++ .../elimelt/pmqueue/impl/package-tree.html | 77 + .../elimelt/pmqueue/impl/package-use.html | 62 + .../elimelt/pmqueue/message/Message.html | 291 ++++ .../pmqueue/message/MessageSerializer.html | 226 +++ .../pmqueue/message/class-use/Message.html | 180 +++ .../message/class-use/MessageSerializer.html | 62 + .../pmqueue/message/package-summary.html | 121 ++ .../elimelt/pmqueue/message/package-tree.html | 77 + .../elimelt/pmqueue/message/package-use.html | 135 ++ .../elimelt/pmqueue/package-summary.html | 137 ++ .../github/elimelt/pmqueue/package-tree.html | 103 ++ .../github/elimelt/pmqueue/package-use.html | 151 ++ .../producer/DefaultMessageProducer.html | 235 +++ .../pmqueue/producer/MessageProducer.html | 183 +++ .../class-use/DefaultMessageProducer.html | 62 + .../producer/class-use/MessageProducer.html | 89 ++ .../pmqueue/producer/package-summary.html | 121 ++ .../pmqueue/producer/package-tree.html | 86 ++ .../elimelt/pmqueue/producer/package-use.html | 86 ++ docs/legal/ADDITIONAL_LICENSE_INFO | 37 + docs/legal/ASSEMBLY_EXCEPTION | 27 + docs/legal/LICENSE | 347 +++++ docs/legal/jquery.md | 72 + docs/legal/jqueryUI.md | 49 + docs/link.svg | 31 + docs/member-search-index.js | 1 + docs/module-search-index.js | 1 + docs/overview-summary.html | 26 + docs/overview-tree.html | 114 ++ docs/package-search-index.js | 1 + docs/resources/glass.png | Bin 0 -> 499 bytes docs/resources/x.png | Bin 0 -> 394 bytes docs/script-dir/jquery-3.6.1.min.js | 2 + docs/script-dir/jquery-ui.min.css | 6 + docs/script-dir/jquery-ui.min.js | 6 + docs/script.js | 253 ++++ docs/search-page.js | 284 ++++ docs/search.html | 77 + docs/search.js | 458 ++++++ docs/serialized-form.html | 143 ++ docs/stylesheet.css | 1272 +++++++++++++++++ docs/tag-search-index.js | 1 + docs/type-search-index.js | 1 + update_javadoc.sh | 33 + 82 files changed, 11844 insertions(+) create mode 100644 docs/META-INF/MANIFEST.MF create mode 100644 docs/allclasses-index.html create mode 100644 docs/allpackages-index.html create mode 100644 docs/constant-values.html create mode 100644 docs/copy.svg create mode 100644 docs/element-list create mode 100644 docs/help-doc.html create mode 100644 docs/index-all.html create mode 100644 docs/index.html create mode 100644 docs/io/github/elimelt/pmqueue/MessageQueue.html create mode 100644 docs/io/github/elimelt/pmqueue/QueueConfig.Builder.html create mode 100644 docs/io/github/elimelt/pmqueue/QueueConfig.html create mode 100644 docs/io/github/elimelt/pmqueue/QueueFactory.CustomQueueBuilder.html create mode 100644 docs/io/github/elimelt/pmqueue/QueueFactory.QueuePreset.html create mode 100644 docs/io/github/elimelt/pmqueue/QueueFactory.html create mode 100644 docs/io/github/elimelt/pmqueue/class-use/MessageQueue.html create mode 100644 docs/io/github/elimelt/pmqueue/class-use/QueueConfig.Builder.html create mode 100644 docs/io/github/elimelt/pmqueue/class-use/QueueConfig.html create mode 100644 docs/io/github/elimelt/pmqueue/class-use/QueueFactory.CustomQueueBuilder.html create mode 100644 docs/io/github/elimelt/pmqueue/class-use/QueueFactory.QueuePreset.html create mode 100644 docs/io/github/elimelt/pmqueue/class-use/QueueFactory.html create mode 100644 docs/io/github/elimelt/pmqueue/consumer/DefaultMessageConsumer.html create mode 100644 docs/io/github/elimelt/pmqueue/consumer/MessageConsumer.html create mode 100644 docs/io/github/elimelt/pmqueue/consumer/class-use/DefaultMessageConsumer.html create mode 100644 docs/io/github/elimelt/pmqueue/consumer/class-use/MessageConsumer.html create mode 100644 docs/io/github/elimelt/pmqueue/consumer/package-summary.html create mode 100644 docs/io/github/elimelt/pmqueue/consumer/package-tree.html create mode 100644 docs/io/github/elimelt/pmqueue/consumer/package-use.html create mode 100644 docs/io/github/elimelt/pmqueue/core/PersistentMessageQueue.html create mode 100644 docs/io/github/elimelt/pmqueue/core/class-use/PersistentMessageQueue.html create mode 100644 docs/io/github/elimelt/pmqueue/core/package-summary.html create mode 100644 docs/io/github/elimelt/pmqueue/core/package-tree.html create mode 100644 docs/io/github/elimelt/pmqueue/core/package-use.html create mode 100644 docs/io/github/elimelt/pmqueue/impl/AutoFlushingQueue.html create mode 100644 docs/io/github/elimelt/pmqueue/impl/ValidatingQueue.html create mode 100644 docs/io/github/elimelt/pmqueue/impl/class-use/AutoFlushingQueue.html create mode 100644 docs/io/github/elimelt/pmqueue/impl/class-use/ValidatingQueue.html create mode 100644 docs/io/github/elimelt/pmqueue/impl/package-summary.html create mode 100644 docs/io/github/elimelt/pmqueue/impl/package-tree.html create mode 100644 docs/io/github/elimelt/pmqueue/impl/package-use.html create mode 100644 docs/io/github/elimelt/pmqueue/message/Message.html create mode 100644 docs/io/github/elimelt/pmqueue/message/MessageSerializer.html create mode 100644 docs/io/github/elimelt/pmqueue/message/class-use/Message.html create mode 100644 docs/io/github/elimelt/pmqueue/message/class-use/MessageSerializer.html create mode 100644 docs/io/github/elimelt/pmqueue/message/package-summary.html create mode 100644 docs/io/github/elimelt/pmqueue/message/package-tree.html create mode 100644 docs/io/github/elimelt/pmqueue/message/package-use.html create mode 100644 docs/io/github/elimelt/pmqueue/package-summary.html create mode 100644 docs/io/github/elimelt/pmqueue/package-tree.html create mode 100644 docs/io/github/elimelt/pmqueue/package-use.html create mode 100644 docs/io/github/elimelt/pmqueue/producer/DefaultMessageProducer.html create mode 100644 docs/io/github/elimelt/pmqueue/producer/MessageProducer.html create mode 100644 docs/io/github/elimelt/pmqueue/producer/class-use/DefaultMessageProducer.html create mode 100644 docs/io/github/elimelt/pmqueue/producer/class-use/MessageProducer.html create mode 100644 docs/io/github/elimelt/pmqueue/producer/package-summary.html create mode 100644 docs/io/github/elimelt/pmqueue/producer/package-tree.html create mode 100644 docs/io/github/elimelt/pmqueue/producer/package-use.html create mode 100644 docs/legal/ADDITIONAL_LICENSE_INFO create mode 100644 docs/legal/ASSEMBLY_EXCEPTION create mode 100644 docs/legal/LICENSE create mode 100644 docs/legal/jquery.md create mode 100644 docs/legal/jqueryUI.md create mode 100644 docs/link.svg create mode 100644 docs/member-search-index.js create mode 100644 docs/module-search-index.js create mode 100644 docs/overview-summary.html create mode 100644 docs/overview-tree.html create mode 100644 docs/package-search-index.js create mode 100644 docs/resources/glass.png create mode 100644 docs/resources/x.png create mode 100644 docs/script-dir/jquery-3.6.1.min.js create mode 100644 docs/script-dir/jquery-ui.min.css create mode 100644 docs/script-dir/jquery-ui.min.js create mode 100644 docs/script.js create mode 100644 docs/search-page.js create mode 100644 docs/search.html create mode 100644 docs/search.js create mode 100644 docs/serialized-form.html create mode 100644 docs/stylesheet.css create mode 100644 docs/tag-search-index.js create mode 100644 docs/type-search-index.js create mode 100755 update_javadoc.sh diff --git a/docs/META-INF/MANIFEST.MF b/docs/META-INF/MANIFEST.MF new file mode 100644 index 0000000..2fe49f6 --- /dev/null +++ b/docs/META-INF/MANIFEST.MF @@ -0,0 +1,4 @@ +Manifest-Version: 1.0 +Created-By: Maven Javadoc Plugin 3.5.0 +Build-Jdk-Spec: 21 + diff --git a/docs/allclasses-index.html b/docs/allclasses-index.html new file mode 100644 index 0000000..f90dfba --- /dev/null +++ b/docs/allclasses-index.html @@ -0,0 +1,126 @@ + + + + +All Classes and Interfaces (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

All Classes and Interfaces

+
+
+
+
+
+
Class
+
Description
+ +
+
Default implementation of MessageConsumer.
+
+ +
+
Default implementation of MessageProducer.
+
+ +
+
A high-performance, immutable message container optimized for memory + efficiency and fast access.
+
+ +
+
Interface for consuming messages.
+
+ +
+
Interface for sending messages.
+
+ +
+
Interface for message queues.
+
+ +
+
A high-performance serializer for Message objects using direct memory + operations.
+
+ +
+
A high-performance, persistent queue implementation for storing messages on + disk.
+
+ +
+
Configuration for a message queue.
+
+ +
+
Builder for QueueConfig.
+
+ +
+
Factory for creating MessageQueue instances with various configurations.
+
+ +
+
Creates a queue with a custom configuration.
+
+ +
+
Predefined queue configurations
+
+
+
+
+
+
+
+ +
+
+
+ + diff --git a/docs/allpackages-index.html b/docs/allpackages-index.html new file mode 100644 index 0000000..98d5765 --- /dev/null +++ b/docs/allpackages-index.html @@ -0,0 +1,77 @@ + + + + +All Packages (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

All Packages

+
+
Package Summary
+ +
+
+
+ +
+
+
+ + diff --git a/docs/constant-values.html b/docs/constant-values.html new file mode 100644 index 0000000..fd65b23 --- /dev/null +++ b/docs/constant-values.html @@ -0,0 +1,90 @@ + + + + +Constant Field Values (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Constant Field Values

+
+
+

Contents

+ +
+
+

io.github.*

+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/copy.svg b/docs/copy.svg new file mode 100644 index 0000000..7c46ab1 --- /dev/null +++ b/docs/copy.svg @@ -0,0 +1,33 @@ + + + + + + + + diff --git a/docs/element-list b/docs/element-list new file mode 100644 index 0000000..340d1e0 --- /dev/null +++ b/docs/element-list @@ -0,0 +1,5 @@ +io.github.elimelt.pmqueue +io.github.elimelt.pmqueue.consumer +io.github.elimelt.pmqueue.core +io.github.elimelt.pmqueue.message +io.github.elimelt.pmqueue.producer diff --git a/docs/help-doc.html b/docs/help-doc.html new file mode 100644 index 0000000..d3e8300 --- /dev/null +++ b/docs/help-doc.html @@ -0,0 +1,203 @@ + + + + +API Help (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+

JavaDoc Help

+ +
+
+

Navigation

+Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces + +
+
+
+

Kinds of Pages

+The following sections describe the different kinds of pages in this collection. +
+

Overview

+

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.

+
+
+

Package

+

Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:

+
    +
  • Interfaces
  • +
  • Classes
  • +
  • Enums
  • +
  • Exception Classes
  • +
  • Annotation Types
  • +
+
+
+

Class or Interface

+

Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.

+
    +
  • Class Inheritance Diagram
  • +
  • Direct Subclasses
  • +
  • All Known Subinterfaces
  • +
  • All Known Implementing Classes
  • +
  • Class or Interface Declaration
  • +
  • Class or Interface Description
  • +
+
+
    +
  • Nested Class Summary
  • +
  • Enum Constant Summary
  • +
  • Field Summary
  • +
  • Property Summary
  • +
  • Constructor Summary
  • +
  • Method Summary
  • +
  • Required Element Summary
  • +
  • Optional Element Summary
  • +
+
+
    +
  • Enum Constant Details
  • +
  • Field Details
  • +
  • Property Details
  • +
  • Constructor Details
  • +
  • Method Details
  • +
  • Element Details
  • +
+

Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.

+

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.

+
+
+

Other Files

+

Packages and modules may contain pages with additional information related to the declarations nearby.

+
+
+

Use

+

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.

+
+
+

Tree (Class Hierarchy)

+

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. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.

+
    +
  • When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
  • +
  • When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
  • +
+
+
+

Constant Field Values

+

The Constant Field Values page lists the static final fields and their values.

+
+
+

Serialized Form

+

Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use 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.

+
+
+

All Packages

+

The All Packages page contains an alphabetic index of all packages contained in the documentation.

+
+
+

All Classes and Interfaces

+

The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.

+
+
+

Index

+

The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.

+
+
+
+This help file applies to API documentation generated by the standard doclet.
+
+
+ +
+
+
+ + diff --git a/docs/index-all.html b/docs/index-all.html new file mode 100644 index 0000000..90760ef --- /dev/null +++ b/docs/index-all.html @@ -0,0 +1,450 @@ + + + + +Index (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Index

+
+B C D F G H I L M O P Q S V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form +

B

+
+
batchThreshold(int) - Method in class io.github.elimelt.pmqueue.QueueConfig.Builder
+
+
Sets the batch threshold for the message queue.
+
+
BLOCK_HEADER_SIZE - Static variable in class io.github.elimelt.pmqueue.core.PersistentMessageQueue
+
+
The size of the block header in bytes.
+
+
build() - Method in class io.github.elimelt.pmqueue.QueueConfig.Builder
+
+
Builds the QueueConfig.
+
+
build() - Method in class io.github.elimelt.pmqueue.QueueFactory.CustomQueueBuilder
+
+
Builds the MessageQueue instance.
+
+
Builder() - Constructor for class io.github.elimelt.pmqueue.QueueConfig.Builder
+
+
Creates a new Builder.
+
+
+

C

+
+
checksumEnabled(boolean) - Method in class io.github.elimelt.pmqueue.QueueConfig.Builder
+
+
Enables or disables checksums.
+
+
close() - Method in class io.github.elimelt.pmqueue.consumer.DefaultMessageConsumer
+
 
+
close() - Method in class io.github.elimelt.pmqueue.core.PersistentMessageQueue
+
+
Closes the queue, ensuring all pending writes are flushed to disk.
+
+
close() - Method in class io.github.elimelt.pmqueue.producer.DefaultMessageProducer
+
 
+
createDebugQueue(String) - Static method in class io.github.elimelt.pmqueue.QueueFactory
+
+
Creates a queue with debug logging enabled.
+
+
createDurableQueue(String) - Static method in class io.github.elimelt.pmqueue.QueueFactory
+
+
Creates a queue optimized for durability and reliability.
+
+
createHighThroughputQueue(String) - Static method in class io.github.elimelt.pmqueue.QueueFactory
+
+
Creates a queue optimized for high throughput scenarios.
+
+
createLargeMessageQueue(String) - Static method in class io.github.elimelt.pmqueue.QueueFactory
+
+
Creates a queue optimized for storing large messages.
+
+
createLowMemoryQueue(String) - Static method in class io.github.elimelt.pmqueue.QueueFactory
+
+
Creates a queue optimized for low memory environments.
+
+
createQueue(String) - Static method in class io.github.elimelt.pmqueue.QueueFactory
+
+
Default queue configuration suitable for general use.
+
+
createQueue(String) - Method in enum io.github.elimelt.pmqueue.QueueFactory.QueuePreset
+
+
Creates a new MessageQueue instance with the specified configuration.
+
+
CustomQueueBuilder() - Constructor for class io.github.elimelt.pmqueue.QueueFactory.CustomQueueBuilder
+
+
Creates a new CustomQueueBuilder.
+
+
+

D

+
+
debugEnabled(boolean) - Method in class io.github.elimelt.pmqueue.QueueConfig.Builder
+
+
Enables or disables debug mode.
+
+
defaultBufferSize(int) - Method in class io.github.elimelt.pmqueue.QueueConfig.Builder
+
+
Sets the default buffer size for the message queue.
+
+
DefaultMessageConsumer - Class in io.github.elimelt.pmqueue.consumer
+
+
Default implementation of MessageConsumer.
+
+
DefaultMessageConsumer(MessageQueue, Consumer<Message>, int, long) - Constructor for class io.github.elimelt.pmqueue.consumer.DefaultMessageConsumer
+
+
Creates a new DefaultMessageConsumer.
+
+
DefaultMessageProducer - Class in io.github.elimelt.pmqueue.producer
+
+
Default implementation of MessageProducer.
+
+
DefaultMessageProducer(MessageQueue) - Constructor for class io.github.elimelt.pmqueue.producer.DefaultMessageProducer
+
+
Creates a new DefaultMessageProducer.
+
+
deserialize(byte[]) - Static method in class io.github.elimelt.pmqueue.message.MessageSerializer
+
+
Deserializes a byte array into a Message object.
+
+
DURABLE - Enum constant in enum io.github.elimelt.pmqueue.QueueFactory.QueuePreset
+
+
Configures the queue with durability settings.
+
+
+

F

+
+
filePath(String) - Method in class io.github.elimelt.pmqueue.QueueConfig.Builder
+
+
Sets the file path for the message queue.
+
+
flushBatch() - Method in class io.github.elimelt.pmqueue.core.PersistentMessageQueue
+
+
Flushes the current write batch to disk.
+
+
+

G

+
+
getBatchThreshold() - Method in class io.github.elimelt.pmqueue.QueueConfig
+
+
Returns the batch threshold for the message queue.
+
+
getConsumerThread() - Method in class io.github.elimelt.pmqueue.consumer.DefaultMessageConsumer
+
+
Returns the consumer thread.
+
+
getData() - Method in class io.github.elimelt.pmqueue.message.Message
+
+
Returns a copy of the message data.
+
+
getDefaultBufferSize() - Method in class io.github.elimelt.pmqueue.QueueConfig
+
+
Returns the default buffer size for the message queue.
+
+
getFilePath() - Method in class io.github.elimelt.pmqueue.QueueConfig
+
+
Returns the file path for the message queue.
+
+
getInitialFileSize() - Method in class io.github.elimelt.pmqueue.QueueConfig
+
+
Returns the initial file size for the message queue.
+
+
getMaxBufferSize() - Method in class io.github.elimelt.pmqueue.QueueConfig
+
+
Returns the maximum buffer size for the message queue.
+
+
getMaxFileSize() - Method in class io.github.elimelt.pmqueue.QueueConfig
+
+
Returns the maximum file size for the message queue.
+
+
getMessageType() - Method in class io.github.elimelt.pmqueue.message.Message
+
+
Returns the message type identifier.
+
+
getRunning() - Method in class io.github.elimelt.pmqueue.consumer.DefaultMessageConsumer
+
+
Returns true if the consumer is running.
+
+
getTimestamp() - Method in class io.github.elimelt.pmqueue.message.Message
+
+
Returns the timestamp when this message was created.
+
+
+

H

+
+
hashCode() - Method in class io.github.elimelt.pmqueue.message.Message
+
+
Computes and caches the hash code for this message using the FNV-1a + algorithm.
+
+
HIGH_THROUGHPUT - Enum constant in enum io.github.elimelt.pmqueue.QueueFactory.QueuePreset
+
+
Configures the queue with high throughput settings.
+
+
+

I

+
+
initialFileSize(int) - Method in class io.github.elimelt.pmqueue.QueueConfig.Builder
+
+
Sets the initial file size for the message queue.
+
+
io.github.elimelt.pmqueue - package io.github.elimelt.pmqueue
+
 
+
io.github.elimelt.pmqueue.consumer - package io.github.elimelt.pmqueue.consumer
+
 
+
io.github.elimelt.pmqueue.core - package io.github.elimelt.pmqueue.core
+
 
+
io.github.elimelt.pmqueue.message - package io.github.elimelt.pmqueue.message
+
 
+
io.github.elimelt.pmqueue.producer - package io.github.elimelt.pmqueue.producer
+
 
+
isChecksumEnabled() - Method in class io.github.elimelt.pmqueue.QueueConfig
+
+
Returns whether checksums are enabled.
+
+
isDebugEnabled() - Method in class io.github.elimelt.pmqueue.QueueConfig
+
+
Returns whether debug mode is enabled.
+
+
isEmpty() - Method in class io.github.elimelt.pmqueue.core.PersistentMessageQueue
+
+
Checks if the queue is empty.
+
+
isEmpty() - Method in interface io.github.elimelt.pmqueue.MessageQueue
+
+
Checks if the queue is empty.
+
+
+

L

+
+
LOW_MEMORY - Enum constant in enum io.github.elimelt.pmqueue.QueueFactory.QueuePreset
+
+
Configures the queue with large message settings.
+
+
+

M

+
+
maxBufferSize(int) - Method in class io.github.elimelt.pmqueue.QueueConfig.Builder
+
+
Sets the maximum buffer size for the message queue.
+
+
maxFileSize(long) - Method in class io.github.elimelt.pmqueue.QueueConfig.Builder
+
+
Sets the maximum file size for the message queue.
+
+
Message - Class in io.github.elimelt.pmqueue.message
+
+
A high-performance, immutable message container optimized for memory + efficiency and fast access.
+
+
Message(byte[], int) - Constructor for class io.github.elimelt.pmqueue.message.Message
+
+
Creates a new Message with the specified data and message type.
+
+
MessageConsumer - Interface in io.github.elimelt.pmqueue.consumer
+
+
Interface for consuming messages.
+
+
MessageProducer - Interface in io.github.elimelt.pmqueue.producer
+
+
Interface for sending messages.
+
+
MessageQueue - Interface in io.github.elimelt.pmqueue
+
+
Interface for message queues.
+
+
MessageSerializer - Class in io.github.elimelt.pmqueue.message
+
+
A high-performance serializer for Message objects using direct memory + operations.
+
+
+

O

+
+
offer(Message) - Method in class io.github.elimelt.pmqueue.core.PersistentMessageQueue
+
+
Offers a message to the queue.
+
+
offer(Message) - Method in interface io.github.elimelt.pmqueue.MessageQueue
+
+
Stores a message in the queue.
+
+
+

P

+
+
PAGE_SIZE - Static variable in class io.github.elimelt.pmqueue.core.PersistentMessageQueue
+
+
The size of a page in bytes.
+
+
PersistentMessageQueue - Class in io.github.elimelt.pmqueue.core
+
+
A high-performance, persistent queue implementation for storing messages on + disk.
+
+
PersistentMessageQueue(QueueConfig) - Constructor for class io.github.elimelt.pmqueue.core.PersistentMessageQueue
+
+
Creates a new persistent message queue with custom configuration.
+
+
PersistentMessageQueue(String) - Constructor for class io.github.elimelt.pmqueue.core.PersistentMessageQueue
+
+
Creates a new persistent message queue with default configuration.
+
+
poll() - Method in class io.github.elimelt.pmqueue.core.PersistentMessageQueue
+
+
Retrieves and removes the head of the queue, or returns null if the queue is + empty.
+
+
poll() - Method in interface io.github.elimelt.pmqueue.MessageQueue
+
+
Retrieves a message from the queue.
+
+
+

Q

+
+
QUEUE_HEADER_SIZE - Static variable in class io.github.elimelt.pmqueue.core.PersistentMessageQueue
+
+
The size of the queue header in bytes.
+
+
QueueConfig - Class in io.github.elimelt.pmqueue
+
+
Configuration for a message queue.
+
+
QueueConfig.Builder - Class in io.github.elimelt.pmqueue
+
+
Builder for QueueConfig.
+
+
QueueFactory - Class in io.github.elimelt.pmqueue
+
+
Factory for creating MessageQueue instances with various configurations.
+
+
QueueFactory.CustomQueueBuilder - Class in io.github.elimelt.pmqueue
+
+
Creates a queue with a custom configuration.
+
+
QueueFactory.QueuePreset - Enum in io.github.elimelt.pmqueue
+
+
Predefined queue configurations
+
+
+

S

+
+
send(byte[], int) - Method in class io.github.elimelt.pmqueue.producer.DefaultMessageProducer
+
 
+
send(byte[], int) - Method in interface io.github.elimelt.pmqueue.producer.MessageProducer
+
+
Sends a message to a message queue.
+
+
serialize(Message) - Static method in class io.github.elimelt.pmqueue.message.MessageSerializer
+
+
Serializes a Message object into a byte array.
+
+
start() - Method in class io.github.elimelt.pmqueue.consumer.DefaultMessageConsumer
+
 
+
start() - Method in interface io.github.elimelt.pmqueue.consumer.MessageConsumer
+
+
Starts consuming messages.
+
+
stop() - Method in class io.github.elimelt.pmqueue.consumer.DefaultMessageConsumer
+
 
+
stop() - Method in interface io.github.elimelt.pmqueue.consumer.MessageConsumer
+
+
Stops consuming messages.
+
+
+

V

+
+
valueOf(String) - Static method in enum io.github.elimelt.pmqueue.QueueFactory.QueuePreset
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Static method in enum io.github.elimelt.pmqueue.QueueFactory.QueuePreset
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
+

W

+
+
withBatchThreshold(int) - Method in class io.github.elimelt.pmqueue.QueueFactory.CustomQueueBuilder
+
+
Sets the batch threshold for the queue.
+
+
withChecksumEnabled(boolean) - Method in class io.github.elimelt.pmqueue.QueueFactory.CustomQueueBuilder
+
+
Enables or disables checksums.
+
+
withDebugEnabled(boolean) - Method in class io.github.elimelt.pmqueue.QueueFactory.CustomQueueBuilder
+
+
Enables or disables debug mode.
+
+
withDefaultBufferSize(int) - Method in class io.github.elimelt.pmqueue.QueueFactory.CustomQueueBuilder
+
+
Sets the initial file size for the queue.
+
+
withFilePath(String) - Method in class io.github.elimelt.pmqueue.QueueFactory.CustomQueueBuilder
+
+
Sets the file path for the queue.
+
+
withMaxBufferSize(int) - Method in class io.github.elimelt.pmqueue.QueueFactory.CustomQueueBuilder
+
+
Sets the maximum buffer size for the queue.
+
+
withMaxFileSize(long) - Method in class io.github.elimelt.pmqueue.QueueFactory.CustomQueueBuilder
+
+
Sets the maximum file size for the queue.
+
+
+B C D F G H I L M O P Q S V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
+
+
+ +
+
+
+ + diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..6aefb94 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,79 @@ + + + + +Overview (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

pmqueue 1.0-SNAPSHOT API

+
+ +
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/MessageQueue.html b/docs/io/github/elimelt/pmqueue/MessageQueue.html new file mode 100644 index 0000000..a6d5512 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/MessageQueue.html @@ -0,0 +1,218 @@ + + + + +MessageQueue (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface MessageQueue

+
+
+
+
All Superinterfaces:
+
AutoCloseable
+
+
+
All Known Implementing Classes:
+
PersistentMessageQueue
+
+
+
public interface MessageQueue +extends AutoCloseable
+
Interface for message queues. + Implementations of this interface are responsible for storing and retrieving + messages. + This interface is thread-safe. + + Example usage: + +

+ MessageQueue queue = new PersistentMessageQueue(
+         new QueueConfig.Builder()
+                 .filePath(filePath)
+                 .build());
+ queue.offer(new Message("Hello, World!".getBytes(), 1));
+ Message message = queue.poll();
+
+ 
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    boolean
    + +
    +
    Checks if the queue is empty.
    +
    +
    boolean
    +
    offer(Message message)
    +
    +
    Stores a message in the queue.
    +
    + + +
    +
    Retrieves a message from the queue.
    +
    +
    +
    +
    +
    +

    Methods inherited from interface java.lang.AutoCloseable

    +close
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      offer

      +
      boolean offer(Message message) + throws IOException
      +
      Stores a message in the queue.
      +
      +
      Parameters:
      +
      message - the message to store
      +
      Returns:
      +
      true if the message was stored, false otherwise
      +
      Throws:
      +
      IOException - if an I/O error occurs
      +
      +
      +
    • +
    • +
      +

      poll

      +
      Message poll() + throws IOException
      +
      Retrieves a message from the queue.
      +
      +
      Returns:
      +
      the message retrieved from the queue
      +
      Throws:
      +
      IOException - if an I/O error occurs
      +
      +
      +
    • +
    • +
      +

      isEmpty

      +
      boolean isEmpty()
      +
      Checks if the queue is empty.
      +
      +
      Returns:
      +
      true if the queue is empty, false otherwise
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/QueueConfig.Builder.html b/docs/io/github/elimelt/pmqueue/QueueConfig.Builder.html new file mode 100644 index 0000000..ba78ed0 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/QueueConfig.Builder.html @@ -0,0 +1,337 @@ + + + + +QueueConfig.Builder (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class QueueConfig.Builder

+
+
java.lang.Object +
io.github.elimelt.pmqueue.QueueConfig.Builder
+
+
+
+
Enclosing class:
+
QueueConfig
+
+
+
public static class QueueConfig.Builder +extends Object
+
Builder for QueueConfig. + This class is mutable and not thread-safe.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Builder

      +
      public Builder()
      +
      Creates a new Builder.
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      filePath

      +
      public QueueConfig.Builder filePath(String filePath)
      +
      Sets the file path for the message queue.
      +
      +
      Parameters:
      +
      filePath - the file path
      +
      Returns:
      +
      this
      +
      +
      +
    • +
    • +
      +

      debugEnabled

      +
      public QueueConfig.Builder debugEnabled(boolean debugEnabled)
      +
      Enables or disables debug mode.
      +
      +
      Parameters:
      +
      debugEnabled - true to enable debug mode, false otherwise
      +
      Returns:
      +
      this
      +
      +
      +
    • +
    • +
      +

      checksumEnabled

      +
      public QueueConfig.Builder checksumEnabled(boolean checksumEnabled)
      +
      Enables or disables checksums.
      +
      +
      Parameters:
      +
      checksumEnabled - true to enable checksums, false otherwise
      +
      Returns:
      +
      this
      +
      +
      +
    • +
    • +
      +

      maxFileSize

      +
      public QueueConfig.Builder maxFileSize(long maxFileSize)
      +
      Sets the maximum file size for the message queue.
      +
      +
      Parameters:
      +
      maxFileSize - the maximum file size
      +
      Returns:
      +
      this
      +
      +
      +
    • +
    • +
      +

      initialFileSize

      +
      public QueueConfig.Builder initialFileSize(int initialFileSize)
      +
      Sets the initial file size for the message queue.
      +
      +
      Parameters:
      +
      initialFileSize - the initial file size
      +
      Returns:
      +
      this
      +
      +
      +
    • +
    • +
      +

      defaultBufferSize

      +
      public QueueConfig.Builder defaultBufferSize(int defaultBufferSize)
      +
      Sets the default buffer size for the message queue.
      +
      +
      Parameters:
      +
      defaultBufferSize - the default buffer size
      +
      Returns:
      +
      this
      +
      +
      +
    • +
    • +
      +

      maxBufferSize

      +
      public QueueConfig.Builder maxBufferSize(int maxBufferSize)
      +
      Sets the maximum buffer size for the message queue.
      +
      +
      Parameters:
      +
      maxBufferSize - the maximum buffer size
      +
      Returns:
      +
      this
      +
      +
      +
    • +
    • +
      +

      batchThreshold

      +
      public QueueConfig.Builder batchThreshold(int batchThreshold)
      +
      Sets the batch threshold for the message queue.
      +
      +
      Parameters:
      +
      batchThreshold - the batch threshold
      +
      Returns:
      +
      this
      +
      +
      +
    • +
    • +
      +

      build

      +
      public QueueConfig build()
      +
      Builds the QueueConfig.
      +
      +
      Returns:
      +
      the QueueConfig
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/QueueConfig.html b/docs/io/github/elimelt/pmqueue/QueueConfig.html new file mode 100644 index 0000000..8f08a40 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/QueueConfig.html @@ -0,0 +1,303 @@ + + + + +QueueConfig (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class QueueConfig

+
+
java.lang.Object +
io.github.elimelt.pmqueue.QueueConfig
+
+
+
+
public class QueueConfig +extends Object
+
Configuration for a message queue. + This class is immutable and thread-safe. + + Example usage: + +

+ QueueConfig config = new QueueConfig.Builder()
+     .filePath(filePath)
+     .debugEnabled(true)
+     .checksumEnabled(true)
+     .maxFileSize(1024 * 1024 * 1024)
+     .initialFileSize(4096)
+     .defaultBufferSize(1024 * 1024)
+     .maxBufferSize(8 * 1024 * 1024)
+     .batchThreshold(64)
+     .build();
+ 
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getFilePath

      +
      public String getFilePath()
      +
      Returns the file path for the message queue.
      +
      +
      Returns:
      +
      the file path
      +
      +
      +
    • +
    • +
      +

      isDebugEnabled

      +
      public boolean isDebugEnabled()
      +
      Returns whether debug mode is enabled.
      +
      +
      Returns:
      +
      true if debug mode is enabled, false otherwise
      +
      +
      +
    • +
    • +
      +

      isChecksumEnabled

      +
      public boolean isChecksumEnabled()
      +
      Returns whether checksums are enabled.
      +
      +
      Returns:
      +
      true if checksums are enabled, false otherwise
      +
      +
      +
    • +
    • +
      +

      getMaxFileSize

      +
      public long getMaxFileSize()
      +
      Returns the maximum file size for the message queue.
      +
      +
      Returns:
      +
      the maximum file size
      +
      +
      +
    • +
    • +
      +

      getInitialFileSize

      +
      public int getInitialFileSize()
      +
      Returns the initial file size for the message queue.
      +
      +
      Returns:
      +
      the initial file size
      +
      +
      +
    • +
    • +
      +

      getDefaultBufferSize

      +
      public int getDefaultBufferSize()
      +
      Returns the default buffer size for the message queue.
      +
      +
      Returns:
      +
      the default buffer size
      +
      +
      +
    • +
    • +
      +

      getMaxBufferSize

      +
      public int getMaxBufferSize()
      +
      Returns the maximum buffer size for the message queue.
      +
      +
      Returns:
      +
      the maximum buffer size
      +
      +
      +
    • +
    • +
      +

      getBatchThreshold

      +
      public int getBatchThreshold()
      +
      Returns the batch threshold for the message queue.
      +
      +
      Returns:
      +
      the batch threshold
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/QueueFactory.CustomQueueBuilder.html b/docs/io/github/elimelt/pmqueue/QueueFactory.CustomQueueBuilder.html new file mode 100644 index 0000000..1d507c2 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/QueueFactory.CustomQueueBuilder.html @@ -0,0 +1,332 @@ + + + + +QueueFactory.CustomQueueBuilder (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class QueueFactory.CustomQueueBuilder

+
+
java.lang.Object +
io.github.elimelt.pmqueue.QueueFactory.CustomQueueBuilder
+
+
+
+
Enclosing class:
+
QueueFactory
+
+
+
public static class QueueFactory.CustomQueueBuilder +extends Object
+
Creates a queue with a custom configuration. + Features configurable buffer sizes, batch threshold, and checksum + verification. +

+ Configuration Defaults: +

    +
  • Default buffer size: 1MB
  • +
  • Max buffer size: 8MB
  • +
  • Batch threshold: 64
  • +
  • Checksums: Enabled
  • +
  • Debug logging: Enabled
  • +
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      CustomQueueBuilder

      +
      public CustomQueueBuilder()
      +
      Creates a new CustomQueueBuilder.
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      withFilePath

      +
      public QueueFactory.CustomQueueBuilder withFilePath(String filePath)
      +
      Sets the file path for the queue.
      +
      +
      Parameters:
      +
      filePath - the file path for the queue
      +
      Returns:
      +
      this
      +
      +
      +
    • +
    • +
      +

      withDebugEnabled

      +
      public QueueFactory.CustomQueueBuilder withDebugEnabled(boolean enabled)
      +
      Enables or disables debug mode.
      +
      +
      Parameters:
      +
      enabled - true to enable debug logging
      +
      Returns:
      +
      this
      +
      +
      +
    • +
    • +
      +

      withChecksumEnabled

      +
      public QueueFactory.CustomQueueBuilder withChecksumEnabled(boolean enabled)
      +
      Enables or disables checksums.
      +
      +
      Parameters:
      +
      enabled - true to enable checksum verification
      +
      Returns:
      +
      this
      +
      +
      +
    • +
    • +
      +

      withMaxFileSize

      +
      public QueueFactory.CustomQueueBuilder withMaxFileSize(long maxFileSize)
      +
      Sets the maximum file size for the queue.
      +
      +
      Parameters:
      +
      maxFileSize - the maximum file size
      +
      Returns:
      +
      this
      +
      +
      +
    • +
    • +
      +

      withDefaultBufferSize

      +
      public QueueFactory.CustomQueueBuilder withDefaultBufferSize(int initialFileSize)
      +
      Sets the initial file size for the queue.
      +
      +
      Parameters:
      +
      initialFileSize - the initial file size
      +
      Returns:
      +
      this
      +
      +
      +
    • +
    • +
      +

      withMaxBufferSize

      +
      public QueueFactory.CustomQueueBuilder withMaxBufferSize(int size)
      +
      Sets the maximum buffer size for the queue.
      +
      +
      Parameters:
      +
      size - the maximum buffer size
      +
      Returns:
      +
      this
      +
      +
      +
    • +
    • +
      +

      withBatchThreshold

      +
      public QueueFactory.CustomQueueBuilder withBatchThreshold(int threshold)
      +
      Sets the batch threshold for the queue.
      +
      +
      Parameters:
      +
      threshold - the batch threshold
      +
      Returns:
      +
      this
      +
      +
      +
    • +
    • +
      +

      build

      +
      public MessageQueue build() + throws IOException
      +
      Builds the MessageQueue instance.
      +
      +
      Returns:
      +
      MessageQueue instance
      +
      Throws:
      +
      IOException - if an I/O error occurs
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/QueueFactory.QueuePreset.html b/docs/io/github/elimelt/pmqueue/QueueFactory.QueuePreset.html new file mode 100644 index 0000000..cda6837 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/QueueFactory.QueuePreset.html @@ -0,0 +1,279 @@ + + + + +QueueFactory.QueuePreset (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Enum QueueFactory.QueuePreset

+
+
java.lang.Object +
java.lang.Enum<QueueFactory.QueuePreset> +
io.github.elimelt.pmqueue.QueueFactory.QueuePreset
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<QueueFactory.QueuePreset>, java.lang.constant.Constable
+
+
+
Enclosing class:
+
QueueFactory
+
+
+
public static enum QueueFactory.QueuePreset +extends Enum<QueueFactory.QueuePreset>
+
Predefined queue configurations
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    +
      +
    • +
      +

      HIGH_THROUGHPUT

      +
      public static final QueueFactory.QueuePreset HIGH_THROUGHPUT
      +
      Configures the queue with high throughput settings.
      +
      +
    • +
    • +
      +

      DURABLE

      +
      public static final QueueFactory.QueuePreset DURABLE
      +
      Configures the queue with durability settings.
      +
      +
    • +
    • +
      +

      LOW_MEMORY

      +
      public static final QueueFactory.QueuePreset LOW_MEMORY
      +
      Configures the queue with large message settings.
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static QueueFactory.QueuePreset[] values()
      +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum type, in the order they are declared
      +
      +
      +
    • +
    • +
      +

      valueOf

      +
      public static QueueFactory.QueuePreset valueOf(String name)
      +
      Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum type has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
    • +
    • +
      +

      createQueue

      +
      public MessageQueue createQueue(String filePath) + throws IOException
      +
      Creates a new MessageQueue instance with the specified configuration.
      +
      +
      Parameters:
      +
      filePath - the file path for the queue
      +
      Returns:
      +
      MessageQueue instance
      +
      Throws:
      +
      IOException - if an I/O error occurs
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/QueueFactory.html b/docs/io/github/elimelt/pmqueue/QueueFactory.html new file mode 100644 index 0000000..be135bb --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/QueueFactory.html @@ -0,0 +1,361 @@ + + + + +QueueFactory (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class QueueFactory

+
+
java.lang.Object +
io.github.elimelt.pmqueue.QueueFactory
+
+
+
+
public class QueueFactory +extends Object
+
Factory for creating MessageQueue instances with various configurations. + This class is thread-safe. + + Example usage: + +

+ String filePath = "path/to/queue.dat";
+ MessageQueue queue = QueueFactory.createQueue(filePath);
+ 
+ + Example usage with custom configuration: + +

+ String filePath = "path/to/queue.dat";
+ MessageQueue queue = new QueueFactory.CustomQueueBuilder()
+         .withFilePath(filePath)
+         .withDebugEnabled(true)
+         .withChecksumEnabled(true)
+         .withMaxFileSize(1024 * 1024 * 1024)
+         .withDefaultBufferSize(1024 * 1024)
+         .withMaxBufferSize(8 * 1024 * 1024)
+         .withBatchThreshold(64)
+         .build();
+ 
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      createQueue

      +
      public static MessageQueue createQueue(String filePath) + throws IOException
      +
      Default queue configuration suitable for general use. + Features moderate buffer sizes and checksum verification.
      +
      +
      Parameters:
      +
      filePath - the file path for the queue
      +
      Returns:
      +
      MessageQueue instance
      +
      Throws:
      +
      IOException - if an I/O error occurs
      +
      +
      +
    • +
    • +
      +

      createHighThroughputQueue

      +
      public static MessageQueue createHighThroughputQueue(String filePath) + throws IOException
      +
      Creates a queue optimized for high throughput scenarios. + Features larger buffers, batching, and less frequent checksum verification. + +

      + Configuration: +

        +
      • Default buffer size: 4MB
      • +
      • Max buffer size: 16MB
      • +
      • Batch threshold: 256
      • +
      • Checksums: Disabled
      • +
      +
      +
      Parameters:
      +
      filePath - the file path for the queue
      +
      Returns:
      +
      MessageQueue instance
      +
      Throws:
      +
      IOException - if an I/O error occurs
      +
      +
      +
    • +
    • +
      +

      createDurableQueue

      +
      public static MessageQueue createDurableQueue(String filePath) + throws IOException
      +
      Creates a queue optimized for durability and reliability. + Features smaller buffers, checksum verification, and debug logging. +

      + Configuration: +

        +
      • Default buffer size: 1MB
      • +
      • Max buffer size: 4MB
      • +
      • Batch threshold: 32
      • +
      • Checksums: Enabled
      • +
      • Debug logging: Enabled
      • +
      +
      +
      Parameters:
      +
      filePath - the file path for the queue
      +
      Returns:
      +
      MessageQueue instance
      +
      Throws:
      +
      IOException - if an I/O error occurs
      +
      +
      +
    • +
    • +
      +

      createLargeMessageQueue

      +
      public static MessageQueue createLargeMessageQueue(String filePath) + throws IOException
      +
      Creates a queue optimized for storing large messages. + Features larger buffers and smaller batch sizes. +

      + Configuration: +

        +
      • Default buffer size: 16MB
      • +
      • Max buffer size: 32MB
      • +
      • Batch threshold: 16
      • +
      +
      +
      Parameters:
      +
      filePath - the file path for the queue
      +
      Returns:
      +
      MessageQueue instance
      +
      Throws:
      +
      IOException - if an I/O error occurs
      +
      +
      +
    • +
    • +
      +

      createLowMemoryQueue

      +
      public static MessageQueue createLowMemoryQueue(String filePath) + throws IOException
      +
      Creates a queue optimized for low memory environments. + Features smaller buffers and batch sizes. +

      + Configuration: +

        +
      • Default buffer size: 256KB
      • +
      • Max buffer size: 1MB
      • +
      • Batch threshold: 16
      • +
      +
      +
      Parameters:
      +
      filePath - the file path for the queue
      +
      Returns:
      +
      MessageQueue instance
      +
      Throws:
      +
      IOException - if an I/O error occurs
      +
      +
      +
    • +
    • +
      +

      createDebugQueue

      +
      public static MessageQueue createDebugQueue(String filePath) + throws IOException
      +
      Creates a queue with debug logging enabled. + Features checksum verification and debug logging. + Note: Debug logging can impact performance. +

      + Configuration: +

        +
      • Default buffer size: 1MB
      • +
      • Max buffer size: 2MB
      • +
      • Batch threshold: 32
      • +
      • Checksums: Enabled
      • +
      • Debug logging: Enabled
      • +
      +
      +
      Parameters:
      +
      filePath - the file path for the queue
      +
      Returns:
      +
      MessageQueue instance
      +
      Throws:
      +
      IOException - if an I/O error occurs
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/class-use/MessageQueue.html b/docs/io/github/elimelt/pmqueue/class-use/MessageQueue.html new file mode 100644 index 0000000..adaacfd --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/class-use/MessageQueue.html @@ -0,0 +1,182 @@ + + + + +Uses of Interface io.github.elimelt.pmqueue.MessageQueue (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
io.github.elimelt.pmqueue.MessageQueue

+
+
Packages that use MessageQueue
+ +
+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/class-use/QueueConfig.Builder.html b/docs/io/github/elimelt/pmqueue/class-use/QueueConfig.Builder.html new file mode 100644 index 0000000..a05722d --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/class-use/QueueConfig.Builder.html @@ -0,0 +1,124 @@ + + + + +Uses of Class io.github.elimelt.pmqueue.QueueConfig.Builder (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
io.github.elimelt.pmqueue.QueueConfig.Builder

+
+
Packages that use QueueConfig.Builder
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/class-use/QueueConfig.html b/docs/io/github/elimelt/pmqueue/class-use/QueueConfig.html new file mode 100644 index 0000000..de8846b --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/class-use/QueueConfig.html @@ -0,0 +1,107 @@ + + + + +Uses of Class io.github.elimelt.pmqueue.QueueConfig (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
io.github.elimelt.pmqueue.QueueConfig

+
+
Packages that use QueueConfig
+ +
+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/class-use/QueueFactory.CustomQueueBuilder.html b/docs/io/github/elimelt/pmqueue/class-use/QueueFactory.CustomQueueBuilder.html new file mode 100644 index 0000000..339693a --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/class-use/QueueFactory.CustomQueueBuilder.html @@ -0,0 +1,119 @@ + + + + +Uses of Class io.github.elimelt.pmqueue.QueueFactory.CustomQueueBuilder (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
io.github.elimelt.pmqueue.QueueFactory.CustomQueueBuilder

+
+ +
+
Package
+
Description
+ +
 
+
+
+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/class-use/QueueFactory.QueuePreset.html b/docs/io/github/elimelt/pmqueue/class-use/QueueFactory.QueuePreset.html new file mode 100644 index 0000000..effdbcd --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/class-use/QueueFactory.QueuePreset.html @@ -0,0 +1,95 @@ + + + + +Uses of Enum io.github.elimelt.pmqueue.QueueFactory.QueuePreset (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum
io.github.elimelt.pmqueue.QueueFactory.QueuePreset

+
+
Packages that use QueueFactory.QueuePreset
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/class-use/QueueFactory.html b/docs/io/github/elimelt/pmqueue/class-use/QueueFactory.html new file mode 100644 index 0000000..e008f1d --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/class-use/QueueFactory.html @@ -0,0 +1,62 @@ + + + + +Uses of Class io.github.elimelt.pmqueue.QueueFactory (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
io.github.elimelt.pmqueue.QueueFactory

+
+No usage of io.github.elimelt.pmqueue.QueueFactory
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/consumer/DefaultMessageConsumer.html b/docs/io/github/elimelt/pmqueue/consumer/DefaultMessageConsumer.html new file mode 100644 index 0000000..60d2ab9 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/consumer/DefaultMessageConsumer.html @@ -0,0 +1,287 @@ + + + + +DefaultMessageConsumer (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class DefaultMessageConsumer

+
+
java.lang.Object +
io.github.elimelt.pmqueue.consumer.DefaultMessageConsumer
+
+
+
+
All Implemented Interfaces:
+
MessageConsumer, AutoCloseable
+
+
+
public class DefaultMessageConsumer +extends Object +implements MessageConsumer
+
Default implementation of MessageConsumer. This class consumes messages from + a + MessageQueue and processes them with a retry mechanism. + This class is thread-safe. + + Example usage: + +

+ MessageQueue queue = new PersistentMessageQueue(
+         new QueueConfig.Builder()
+                 .filePath(filePath)
+                 .build());
+ MessageConsumer consumer = new DefaultMessageConsumer(
+         queue,
+         message -> System.out.println(new String(message.getData())),
+         3,
+         1000);
+ consumer.start();
+ 
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      DefaultMessageConsumer

      +
      public DefaultMessageConsumer(MessageQueue queue, + Consumer<Message> messageHandler, + int maxRetries, + long retryDelayMs)
      +
      Creates a new DefaultMessageConsumer.
      +
      +
      Parameters:
      +
      queue - the MessageQueue to consume messages from
      +
      messageHandler - the message handler
      +
      maxRetries - the maximum number of retries
      +
      retryDelayMs - the delay between retries
      +
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      start

      +
      public void start()
      +
      Description copied from interface: MessageConsumer
      +
      Starts consuming messages.
      +
      +
      Specified by:
      +
      start in interface MessageConsumer
      +
      +
      +
    • +
    • +
      +

      stop

      +
      public void stop()
      +
      Description copied from interface: MessageConsumer
      +
      Stops consuming messages.
      +
      +
      Specified by:
      +
      stop in interface MessageConsumer
      +
      +
      +
    • +
    • +
      +

      close

      +
      public void close()
      +
      +
      Specified by:
      +
      close in interface AutoCloseable
      +
      +
      +
    • +
    • +
      +

      getRunning

      +
      public boolean getRunning()
      +
      Returns true if the consumer is running.
      +
      +
      Returns:
      +
      true if the consumer is running
      +
      +
      +
    • +
    • +
      +

      getConsumerThread

      +
      public Thread getConsumerThread()
      +
      Returns the consumer thread.
      +
      +
      Returns:
      +
      the consumer thread
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/consumer/MessageConsumer.html b/docs/io/github/elimelt/pmqueue/consumer/MessageConsumer.html new file mode 100644 index 0000000..1c94363 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/consumer/MessageConsumer.html @@ -0,0 +1,190 @@ + + + + +MessageConsumer (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface MessageConsumer

+
+
+
+
All Superinterfaces:
+
AutoCloseable
+
+
+
All Known Implementing Classes:
+
DefaultMessageConsumer
+
+
+
public interface MessageConsumer +extends AutoCloseable
+
Interface for consuming messages. + Implementations of this interface are responsible for consuming messages from + a + message queue. + This interface is thread-safe. + + Example usage: + +

+ MessageQueue queue = new PersistentMessageQueue(
+     new QueueConfig.Builder()
+         .filePath(filePath)
+         .build());
+ MessageConsumer consumer = new DefaultMessageConsumer(
+     queue,
+     message -> System.out.println(new String(message.getData())),
+     3,
+     1000);
+ consumer.start();
+ 
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    + +
    +
    Starts consuming messages.
    +
    +
    void
    + +
    +
    Stops consuming messages.
    +
    +
    +
    +
    +
    +

    Methods inherited from interface java.lang.AutoCloseable

    +close
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      start

      +
      void start()
      +
      Starts consuming messages.
      +
      +
    • +
    • +
      +

      stop

      +
      void stop()
      +
      Stops consuming messages.
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/consumer/class-use/DefaultMessageConsumer.html b/docs/io/github/elimelt/pmqueue/consumer/class-use/DefaultMessageConsumer.html new file mode 100644 index 0000000..ed17841 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/consumer/class-use/DefaultMessageConsumer.html @@ -0,0 +1,62 @@ + + + + +Uses of Class io.github.elimelt.pmqueue.consumer.DefaultMessageConsumer (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
io.github.elimelt.pmqueue.consumer.DefaultMessageConsumer

+
+No usage of io.github.elimelt.pmqueue.consumer.DefaultMessageConsumer
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/consumer/class-use/MessageConsumer.html b/docs/io/github/elimelt/pmqueue/consumer/class-use/MessageConsumer.html new file mode 100644 index 0000000..eea85f7 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/consumer/class-use/MessageConsumer.html @@ -0,0 +1,89 @@ + + + + +Uses of Interface io.github.elimelt.pmqueue.consumer.MessageConsumer (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
io.github.elimelt.pmqueue.consumer.MessageConsumer

+
+
Packages that use MessageConsumer
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/consumer/package-summary.html b/docs/io/github/elimelt/pmqueue/consumer/package-summary.html new file mode 100644 index 0000000..623099e --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/consumer/package-summary.html @@ -0,0 +1,121 @@ + + + + +io.github.elimelt.pmqueue.consumer (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package io.github.elimelt.pmqueue.consumer

+
+
+
package io.github.elimelt.pmqueue.consumer
+
+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/consumer/package-tree.html b/docs/io/github/elimelt/pmqueue/consumer/package-tree.html new file mode 100644 index 0000000..7f409cc --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/consumer/package-tree.html @@ -0,0 +1,86 @@ + + + + +io.github.elimelt.pmqueue.consumer Class Hierarchy (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package io.github.elimelt.pmqueue.consumer

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/consumer/package-use.html b/docs/io/github/elimelt/pmqueue/consumer/package-use.html new file mode 100644 index 0000000..168cfab --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/consumer/package-use.html @@ -0,0 +1,86 @@ + + + + +Uses of Package io.github.elimelt.pmqueue.consumer (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
io.github.elimelt.pmqueue.consumer

+
+ +
+
Package
+
Description
+ +
 
+
+
+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/core/PersistentMessageQueue.html b/docs/io/github/elimelt/pmqueue/core/PersistentMessageQueue.html new file mode 100644 index 0000000..53f8184 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/core/PersistentMessageQueue.html @@ -0,0 +1,490 @@ + + + + +PersistentMessageQueue (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class PersistentMessageQueue

+
+
java.lang.Object +
io.github.elimelt.pmqueue.core.PersistentMessageQueue
+
+
+
+
All Implemented Interfaces:
+
MessageQueue, AutoCloseable
+
+
+
public class PersistentMessageQueue +extends Object +implements MessageQueue
+
A high-performance, persistent queue implementation for storing messages on + disk. + This queue provides durability guarantees while maintaining efficient read + and write + operations through various optimizations including write batching and direct + I/O. + +

+ The queue stores messages in a single file with the following structure: +

    +
  • Queue Header (24 bytes): +
      +
    • Front offset (8 bytes) +
    • Rear offset (8 bytes) +
    • Reserved (8 bytes) +
    +
  • Message Blocks: +
      +
    • Block Header (8 bytes): +
        +
      • Message size (4 bytes) +
      • CRC32 checksum (4 bytes) +
      +
    • Message data (variable size) +
    +
+ +

+ Key features: +

    +
  • Write batching for improved performance +
  • Direct ByteBuffers for efficient I/O +
  • CRC32 checksums for data integrity +
  • Fair locking for predictable ordering +
  • Automatic file size management +
  • Thread-safe operations +
+ +

+ Example usage: + + // Create a new queue + try (PersistentMessageQueue queue = new PersistentMessageQueue("messages.queue")) { + // Create and offer a message + Message msg1 = new Message("Hello".getBytes(), 1); + queue.offer(msg1); + + // Poll a message from the queue + Message received = queue.poll(); + if (received != null) { + System.out.println(new String(received.getData())); + } + } + + +

+ Performance considerations: +

    +
  • Small messages are batched together for better throughput +
  • Large messages are written directly to disk +
  • File size grows dynamically but is limited to 1GB +
  • Default buffer size is 1MB, aligned to page boundaries +
+
+
+
    + +
  • +
    +

    Field Summary

    +
    Fields
    +
    +
    Modifier and Type
    +
    Field
    +
    Description
    +
    static final int
    + +
    +
    The size of the block header in bytes.
    +
    +
    static final int
    + +
    +
    The size of a page in bytes.
    +
    +
    static final int
    + +
    +
    The size of the queue header in bytes.
    +
    +
    +
    +
  • + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    + +
    +
    Creates a new persistent message queue with custom configuration.
    +
    + +
    +
    Creates a new persistent message queue with default configuration.
    +
    +
    +
    +
  • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    + +
    +
    Closes the queue, ensuring all pending writes are flushed to disk.
    +
    +
    void
    + +
    +
    Flushes the current write batch to disk.
    +
    +
    boolean
    + +
    +
    Checks if the queue is empty.
    +
    +
    boolean
    +
    offer(Message message)
    +
    +
    Offers a message to the queue.
    +
    + + +
    +
    Retrieves and removes the head of the queue, or returns null if the queue is + empty.
    +
    +
    +
    +
    +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      QUEUE_HEADER_SIZE

      +
      public static final int QUEUE_HEADER_SIZE
      +
      The size of the queue header in bytes.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
    • +
    • +
      +

      BLOCK_HEADER_SIZE

      +
      public static final int BLOCK_HEADER_SIZE
      +
      The size of the block header in bytes.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
    • +
    • +
      +

      PAGE_SIZE

      +
      public static final int PAGE_SIZE
      +
      The size of a page in bytes.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      PersistentMessageQueue

      +
      public PersistentMessageQueue(QueueConfig config) + throws IOException
      +
      Creates a new persistent message queue with custom configuration.
      +
      +
      Parameters:
      +
      config - the configuration for the queue
      +
      Throws:
      +
      IOException - if the file cannot be created/opened or if the + existing file is corrupted
      +
      SecurityException - if the application doesn't have required file + permissions
      +
      +
      +
    • +
    • +
      +

      PersistentMessageQueue

      +
      public PersistentMessageQueue(String filename) + throws IOException
      +
      Creates a new persistent message queue with default configuration. + This constructor is maintained for backward compatibility.
      +
      +
      Parameters:
      +
      filename - the path to the queue file
      +
      Throws:
      +
      IOException - if the file cannot be created/opened or if the + existing file is corrupted
      +
      SecurityException - if the application doesn't have required file + permissions
      +
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      offer

      +
      public boolean offer(Message message) + throws IOException
      +
      Offers a message to the queue. + +

      + Messages smaller than 256KB are batched together for better performance. + Larger messages are written directly to disk. If the queue file would exceed + its maximum size (1GB), the message is rejected. + +

      + Example: + + Message msg = new Message("Important data".getBytes(), 1); + boolean success = queue.offer(msg); + if (!success) { + System.err.println("Queue is full"); + } +

      +
      +
      Specified by:
      +
      offer in interface MessageQueue
      +
      Parameters:
      +
      message - the message to add to the queue
      +
      Returns:
      +
      true if the message was added, false if the queue is full
      +
      Throws:
      +
      IOException - if an I/O error occurs
      +
      NullPointerException - if message is null
      +
      +
      +
    • +
    • +
      +

      poll

      +
      public Message poll() + throws IOException
      +
      Retrieves and removes the head of the queue, or returns null if the queue is + empty. + +

      + This operation ensures data integrity by validating the CRC32 checksum of the + message before returning it. + +

      + Example: + + while (true) { + Message msg = queue.poll(); + if (msg == null) { + // Queue is empty + break; + } + processMessage(msg); + } +

      +
      +
      Specified by:
      +
      poll in interface MessageQueue
      +
      Returns:
      +
      the head message of the queue, or null if the queue is empty
      +
      Throws:
      +
      IOException - if an I/O error occurs or if the message data is + corrupted
      +
      +
      +
    • +
    • +
      +

      isEmpty

      +
      public boolean isEmpty()
      +
      Checks if the queue is empty.
      +
      +
      Specified by:
      +
      isEmpty in interface MessageQueue
      +
      Returns:
      +
      true if the queue contains no messages, false otherwise
      +
      +
      +
    • +
    • +
      +

      close

      +
      public void close() + throws IOException
      +
      Closes the queue, ensuring all pending writes are flushed to disk. + +

      + This method should be called when the queue is no longer needed to + ensure proper resource cleanup. It's recommended to use try-with-resources + to ensure the queue is properly closed.

      +
      +
      Specified by:
      +
      close in interface AutoCloseable
      +
      Throws:
      +
      IOException - if an I/O error occurs while closing
      +
      +
      +
    • +
    • +
      +

      flushBatch

      +
      public void flushBatch() + throws IOException
      +
      Flushes the current write batch to disk.
      +
      +
      Throws:
      +
      IOException - if an I/O error occurs
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/core/class-use/PersistentMessageQueue.html b/docs/io/github/elimelt/pmqueue/core/class-use/PersistentMessageQueue.html new file mode 100644 index 0000000..e7a6a8a --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/core/class-use/PersistentMessageQueue.html @@ -0,0 +1,62 @@ + + + + +Uses of Class io.github.elimelt.pmqueue.core.PersistentMessageQueue (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
io.github.elimelt.pmqueue.core.PersistentMessageQueue

+
+No usage of io.github.elimelt.pmqueue.core.PersistentMessageQueue
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/core/package-summary.html b/docs/io/github/elimelt/pmqueue/core/package-summary.html new file mode 100644 index 0000000..7c2f397 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/core/package-summary.html @@ -0,0 +1,116 @@ + + + + +io.github.elimelt.pmqueue.core (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package io.github.elimelt.pmqueue.core

+
+
+
package io.github.elimelt.pmqueue.core
+
+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/core/package-tree.html b/docs/io/github/elimelt/pmqueue/core/package-tree.html new file mode 100644 index 0000000..e0c39cf --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/core/package-tree.html @@ -0,0 +1,76 @@ + + + + +io.github.elimelt.pmqueue.core Class Hierarchy (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package io.github.elimelt.pmqueue.core

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/core/package-use.html b/docs/io/github/elimelt/pmqueue/core/package-use.html new file mode 100644 index 0000000..e9121c4 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/core/package-use.html @@ -0,0 +1,62 @@ + + + + +Uses of Package io.github.elimelt.pmqueue.core (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
io.github.elimelt.pmqueue.core

+
+No usage of io.github.elimelt.pmqueue.core
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/impl/AutoFlushingQueue.html b/docs/io/github/elimelt/pmqueue/impl/AutoFlushingQueue.html new file mode 100644 index 0000000..3edfd0d --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/impl/AutoFlushingQueue.html @@ -0,0 +1,282 @@ + + + + +AutoFlushingQueue (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class AutoFlushingQueue

+
+
java.lang.Object +
io.github.elimelt.pmqueue.impl.AutoFlushingQueue
+
+
+
+
All Implemented Interfaces:
+
MessageQueue, AutoCloseable
+
+
+
public class AutoFlushingQueue +extends Object +implements MessageQueue
+
Decorator for adding periodic flush capabilities to PersistentMessageQueue. + This class periodically flushes the queue to disk at a configurable interval. + This can be useful for ensuring that messages are not lost in the event of a + crash. + + This class is thread-safe. + + Example usage: + +

+ String filePath = "path/to/queue.dat";
+ MessageQueue queue = new AutoFlushingQueue(
+     new PersistentMessageQueue(
+         new QueueConfig.Builder()
+             .filePath(filePath)
+             .build()),
+     1000);
+ 
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      AutoFlushingQueue

      +
      public AutoFlushingQueue(PersistentMessageQueue queue, + long flushIntervalMs)
      +
      Creates a new AutoFlushingQueue.
      +
      +
      Parameters:
      +
      queue - the underlying PersistentMessageQueue
      +
      flushIntervalMs - the interval at which to flush the queue
      +
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      offer

      +
      public boolean offer(Message message) + throws IOException
      +
      Description copied from interface: MessageQueue
      +
      Stores a message in the queue.
      +
      +
      Specified by:
      +
      offer in interface MessageQueue
      +
      Parameters:
      +
      message - the message to store
      +
      Returns:
      +
      true if the message was stored, false otherwise
      +
      Throws:
      +
      IOException - if an I/O error occurs
      +
      +
      +
    • +
    • +
      +

      poll

      +
      public Message poll() + throws IOException
      +
      Description copied from interface: MessageQueue
      +
      Retrieves a message from the queue.
      +
      +
      Specified by:
      +
      poll in interface MessageQueue
      +
      Returns:
      +
      the message retrieved from the queue
      +
      Throws:
      +
      IOException - if an I/O error occurs
      +
      +
      +
    • +
    • +
      +

      isEmpty

      +
      public boolean isEmpty()
      +
      Description copied from interface: MessageQueue
      +
      Checks if the queue is empty.
      +
      +
      Specified by:
      +
      isEmpty in interface MessageQueue
      +
      Returns:
      +
      true if the queue is empty, false otherwise
      +
      +
      +
    • +
    • +
      +

      close

      +
      public void close() + throws IOException
      +
      +
      Specified by:
      +
      close in interface AutoCloseable
      +
      Throws:
      +
      IOException
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/impl/ValidatingQueue.html b/docs/io/github/elimelt/pmqueue/impl/ValidatingQueue.html new file mode 100644 index 0000000..b639b87 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/impl/ValidatingQueue.html @@ -0,0 +1,278 @@ + + + + +ValidatingQueue (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class ValidatingQueue

+
+
java.lang.Object +
io.github.elimelt.pmqueue.impl.ValidatingQueue
+
+
+
+
All Implemented Interfaces:
+
MessageQueue, AutoCloseable
+
+
+
public class ValidatingQueue +extends Object +implements MessageQueue
+
Decorator for message validation. This class validates that messages are not + null and do not exceed a maximum size. + This class is thread-safe. + + Example usage: + +

+ MessageQueue queue = new ValidatingQueue(
+         new PersistentMessageQueue(
+                 new QueueConfig.Builder()
+                         .filePath(filePath)
+                         .build()),
+         1024);
+ 
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ValidatingQueue

      +
      public ValidatingQueue(MessageQueue queue, + int maxMessageSize)
      +
      Creates a new ValidatingQueue.
      +
      +
      Parameters:
      +
      queue - the underlying MessageQueue
      +
      maxMessageSize - the maximum size of a message
      +
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      offer

      +
      public boolean offer(Message message) + throws IOException
      +
      Description copied from interface: MessageQueue
      +
      Stores a message in the queue.
      +
      +
      Specified by:
      +
      offer in interface MessageQueue
      +
      Parameters:
      +
      message - the message to store
      +
      Returns:
      +
      true if the message was stored, false otherwise
      +
      Throws:
      +
      IOException - if an I/O error occurs
      +
      +
      +
    • +
    • +
      +

      poll

      +
      public Message poll() + throws IOException
      +
      Description copied from interface: MessageQueue
      +
      Retrieves a message from the queue.
      +
      +
      Specified by:
      +
      poll in interface MessageQueue
      +
      Returns:
      +
      the message retrieved from the queue
      +
      Throws:
      +
      IOException - if an I/O error occurs
      +
      +
      +
    • +
    • +
      +

      isEmpty

      +
      public boolean isEmpty()
      +
      Description copied from interface: MessageQueue
      +
      Checks if the queue is empty.
      +
      +
      Specified by:
      +
      isEmpty in interface MessageQueue
      +
      Returns:
      +
      true if the queue is empty, false otherwise
      +
      +
      +
    • +
    • +
      +

      close

      +
      public void close() + throws Exception
      +
      +
      Specified by:
      +
      close in interface AutoCloseable
      +
      Throws:
      +
      Exception
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/impl/class-use/AutoFlushingQueue.html b/docs/io/github/elimelt/pmqueue/impl/class-use/AutoFlushingQueue.html new file mode 100644 index 0000000..3d4725e --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/impl/class-use/AutoFlushingQueue.html @@ -0,0 +1,62 @@ + + + + +Uses of Class io.github.elimelt.pmqueue.impl.AutoFlushingQueue (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
io.github.elimelt.pmqueue.impl.AutoFlushingQueue

+
+No usage of io.github.elimelt.pmqueue.impl.AutoFlushingQueue
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/impl/class-use/ValidatingQueue.html b/docs/io/github/elimelt/pmqueue/impl/class-use/ValidatingQueue.html new file mode 100644 index 0000000..cda2252 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/impl/class-use/ValidatingQueue.html @@ -0,0 +1,62 @@ + + + + +Uses of Class io.github.elimelt.pmqueue.impl.ValidatingQueue (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
io.github.elimelt.pmqueue.impl.ValidatingQueue

+
+No usage of io.github.elimelt.pmqueue.impl.ValidatingQueue
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/impl/package-summary.html b/docs/io/github/elimelt/pmqueue/impl/package-summary.html new file mode 100644 index 0000000..86f0a14 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/impl/package-summary.html @@ -0,0 +1,121 @@ + + + + +io.github.elimelt.pmqueue.impl (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package io.github.elimelt.pmqueue.impl

+
+
+
package io.github.elimelt.pmqueue.impl
+
+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/impl/package-tree.html b/docs/io/github/elimelt/pmqueue/impl/package-tree.html new file mode 100644 index 0000000..059ddcd --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/impl/package-tree.html @@ -0,0 +1,77 @@ + + + + +io.github.elimelt.pmqueue.impl Class Hierarchy (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package io.github.elimelt.pmqueue.impl

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/impl/package-use.html b/docs/io/github/elimelt/pmqueue/impl/package-use.html new file mode 100644 index 0000000..3a9f42d --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/impl/package-use.html @@ -0,0 +1,62 @@ + + + + +Uses of Package io.github.elimelt.pmqueue.impl (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
io.github.elimelt.pmqueue.impl

+
+No usage of io.github.elimelt.pmqueue.impl
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/message/Message.html b/docs/io/github/elimelt/pmqueue/message/Message.html new file mode 100644 index 0000000..5987090 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/message/Message.html @@ -0,0 +1,291 @@ + + + + +Message (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class Message

+
+
java.lang.Object +
io.github.elimelt.pmqueue.message.Message
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class Message +extends Object +implements Serializable
+
A high-performance, immutable message container optimized for memory + efficiency and fast access. + This class uses direct memory operations via Unsafe for + improved performance + and implements custom serialization for better control over the serialization + process. + +

+ The message contains: +

    +
  • A byte array containing the message data +
  • A timestamp recording when the message was created +
  • A message type identifier +
+ +

+ This class implements optimizations including: +

    +
  • Direct memory access using Unsafe for field operations +
  • Cached hash code using soft references to allow GC if memory is tight +
  • Custom serialization implementation for performance +
+
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    +
    Message(byte[] data, + int messageType)
    +
    +
    Creates a new Message with the specified data and message type.
    +
    +
    +
    +
  • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    byte[]
    + +
    +
    Returns a copy of the message data.
    +
    +
    int
    + +
    +
    Returns the message type identifier.
    +
    +
    long
    + +
    +
    Returns the timestamp when this message was created.
    +
    +
    int
    + +
    +
    Computes and caches the hash code for this message using the FNV-1a + algorithm.
    +
    +
    +
    +
    +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Message

      +
      public Message(byte[] data, + int messageType)
      +
      Creates a new Message with the specified data and message type. + The message's timestamp is automatically set to the current system time. + A defensive copy of the input data is made to ensure immutability.
      +
      +
      Parameters:
      +
      data - the byte array containing the message data
      +
      messageType - an integer identifying the type of message
      +
      Throws:
      +
      NullPointerException - if data is null
      +
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getData

      +
      public byte[] getData()
      +
      Returns a copy of the message data. + A new array is created and returned each time to preserve immutability.
      +
      +
      Returns:
      +
      a copy of the message data as a byte array
      +
      +
      +
    • +
    • +
      +

      getTimestamp

      +
      public long getTimestamp()
      +
      Returns the timestamp when this message was created.
      +
      +
      Returns:
      +
      the message creation timestamp as milliseconds since epoch
      +
      +
      +
    • +
    • +
      +

      getMessageType

      +
      public int getMessageType()
      +
      Returns the message type identifier.
      +
      +
      Returns:
      +
      the integer message type
      +
      +
      +
    • +
    • +
      +

      hashCode

      +
      public int hashCode()
      +
      Computes and caches the hash code for this message using the FNV-1a + algorithm. + The hash is computed based on the message data, timestamp, and message type. + The computed hash is cached using a SoftReference to allow garbage + collection + if memory is tight.
      +
      +
      Overrides:
      +
      hashCode in class Object
      +
      Returns:
      +
      the hash code for this message
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/message/MessageSerializer.html b/docs/io/github/elimelt/pmqueue/message/MessageSerializer.html new file mode 100644 index 0000000..e74bdc1 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/message/MessageSerializer.html @@ -0,0 +1,226 @@ + + + + +MessageSerializer (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class MessageSerializer

+
+
java.lang.Object +
io.github.elimelt.pmqueue.message.MessageSerializer
+
+
+
+
public class MessageSerializer +extends Object
+
A high-performance serializer for Message objects using direct memory + operations. + This class provides methods to convert Message objects to and from + byte arrays + with minimal overhead and maximum performance. + +

+ The serialization format consists of: +

    +
  • 8 bytes: timestamp (long) +
  • 4 bytes: message type (int) +
  • 4 bytes: data length (int) +
  • n bytes: message data +
+ +

+ Performance optimizations include: +

    +
  • Thread-local ByteBuffer reuse to minimize allocation +
  • Direct memory operations using Unsafe +
  • Buffer size doubling strategy for growing buffers +
+ +

+ Note: This class is not intended for external use and + should only be used by the Message class's serialization mechanism.

+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      serialize

      +
      public static byte[] serialize(Message message) + throws IOException
      +
      Serializes a Message object into a byte array. + The resulting byte array contains the message's timestamp, type, length, + and data in a compact binary format. + +

      + This method uses thread-local direct ByteBuffers to optimize + performance and minimize garbage collection pressure. The buffer size + automatically grows if needed.

      +
      +
      Parameters:
      +
      message - the Message object to serialize
      +
      Returns:
      +
      a byte array containing the serialized message
      +
      Throws:
      +
      IOException - if the message is null or cannot be serialized
      +
      OutOfMemoryError - if unable to allocate required buffer space
      +
      +
      +
    • +
    • +
      +

      deserialize

      +
      public static Message deserialize(byte[] bytes) + throws IOException
      +
      Deserializes a byte array into a Message object. + The byte array must contain data in the format produced by + serialize(io.github.elimelt.pmqueue.message.Message). + +

      + This method creates a new Message object with the original timestamp + preserved through anonymous subclassing. The message type and data are + extracted from the serialized format using direct memory operations for + optimal performance.

      +
      +
      Parameters:
      +
      bytes - the byte array containing the serialized message
      +
      Returns:
      +
      a new Message object with the deserialized data
      +
      Throws:
      +
      IOException - if the byte array is too short, contains invalid length + information, or is otherwise malformed
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/message/class-use/Message.html b/docs/io/github/elimelt/pmqueue/message/class-use/Message.html new file mode 100644 index 0000000..88af3f6 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/message/class-use/Message.html @@ -0,0 +1,180 @@ + + + + +Uses of Class io.github.elimelt.pmqueue.message.Message (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
io.github.elimelt.pmqueue.message.Message

+
+
Packages that use Message
+ +
+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/message/class-use/MessageSerializer.html b/docs/io/github/elimelt/pmqueue/message/class-use/MessageSerializer.html new file mode 100644 index 0000000..9d998d2 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/message/class-use/MessageSerializer.html @@ -0,0 +1,62 @@ + + + + +Uses of Class io.github.elimelt.pmqueue.message.MessageSerializer (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
io.github.elimelt.pmqueue.message.MessageSerializer

+
+No usage of io.github.elimelt.pmqueue.message.MessageSerializer
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/message/package-summary.html b/docs/io/github/elimelt/pmqueue/message/package-summary.html new file mode 100644 index 0000000..3742f44 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/message/package-summary.html @@ -0,0 +1,121 @@ + + + + +io.github.elimelt.pmqueue.message (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package io.github.elimelt.pmqueue.message

+
+
+
package io.github.elimelt.pmqueue.message
+
+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/message/package-tree.html b/docs/io/github/elimelt/pmqueue/message/package-tree.html new file mode 100644 index 0000000..01ab075 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/message/package-tree.html @@ -0,0 +1,77 @@ + + + + +io.github.elimelt.pmqueue.message Class Hierarchy (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package io.github.elimelt.pmqueue.message

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/message/package-use.html b/docs/io/github/elimelt/pmqueue/message/package-use.html new file mode 100644 index 0000000..6d5da30 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/message/package-use.html @@ -0,0 +1,135 @@ + + + + +Uses of Package io.github.elimelt.pmqueue.message (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
io.github.elimelt.pmqueue.message

+
+ + +
+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/package-summary.html b/docs/io/github/elimelt/pmqueue/package-summary.html new file mode 100644 index 0000000..76cee2e --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/package-summary.html @@ -0,0 +1,137 @@ + + + + +io.github.elimelt.pmqueue (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package io.github.elimelt.pmqueue

+
+
+
package io.github.elimelt.pmqueue
+
+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/package-tree.html b/docs/io/github/elimelt/pmqueue/package-tree.html new file mode 100644 index 0000000..f9fb2ef --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/package-tree.html @@ -0,0 +1,103 @@ + + + + +io.github.elimelt.pmqueue Class Hierarchy (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package io.github.elimelt.pmqueue

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Enum Hierarchy

+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/package-use.html b/docs/io/github/elimelt/pmqueue/package-use.html new file mode 100644 index 0000000..2f99c34 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/package-use.html @@ -0,0 +1,151 @@ + + + + +Uses of Package io.github.elimelt.pmqueue (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
io.github.elimelt.pmqueue

+
+
Packages that use io.github.elimelt.pmqueue
+ +
+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/producer/DefaultMessageProducer.html b/docs/io/github/elimelt/pmqueue/producer/DefaultMessageProducer.html new file mode 100644 index 0000000..0ae35a7 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/producer/DefaultMessageProducer.html @@ -0,0 +1,235 @@ + + + + +DefaultMessageProducer (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class DefaultMessageProducer

+
+
java.lang.Object +
io.github.elimelt.pmqueue.producer.DefaultMessageProducer
+
+
+
+
All Implemented Interfaces:
+
MessageProducer, AutoCloseable
+
+
+
public class DefaultMessageProducer +extends Object +implements MessageProducer
+
Default implementation of MessageProducer. This class sends messages to a + MessageQueue. + This class is thread-safe. + + Example usage: + +

+ MessageQueue queue = new PersistentMessageQueue(
+         new QueueConfig.Builder()
+                 .filePath(filePath)
+                 .build());
+ MessageProducer producer = new DefaultMessageProducer(queue);
+ producer.send("Hello, World!".getBytes(), 1);
+ 
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      DefaultMessageProducer

      +
      public DefaultMessageProducer(MessageQueue queue)
      +
      Creates a new DefaultMessageProducer.
      +
      +
      Parameters:
      +
      queue - the MessageQueue to send messages to
      +
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      send

      +
      public void send(byte[] data, + int messageType) + throws IOException
      +
      Description copied from interface: MessageProducer
      +
      Sends a message to a message queue.
      +
      +
      Specified by:
      +
      send in interface MessageProducer
      +
      Parameters:
      +
      data - the message data
      +
      messageType - the message type
      +
      Throws:
      +
      IOException - if an I/O error occurs
      +
      +
      +
    • +
    • +
      +

      close

      +
      public void close() + throws Exception
      +
      +
      Specified by:
      +
      close in interface AutoCloseable
      +
      Throws:
      +
      Exception
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/producer/MessageProducer.html b/docs/io/github/elimelt/pmqueue/producer/MessageProducer.html new file mode 100644 index 0000000..8bf9a05 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/producer/MessageProducer.html @@ -0,0 +1,183 @@ + + + + +MessageProducer (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface MessageProducer

+
+
+
+
All Superinterfaces:
+
AutoCloseable
+
+
+
All Known Implementing Classes:
+
DefaultMessageProducer
+
+
+
public interface MessageProducer +extends AutoCloseable
+
Interface for sending messages. + Implementations of this interface are responsible for sending messages to a + message queue. + This interface is thread-safe. + + Example usage: + +

+ MessageQueue queue = new PersistentMessageQueue(
+     new QueueConfig.Builder()
+         .filePath(filePath)
+         .build());
+ MessageProducer producer = new DefaultMessageProducer(queue);
+ producer.send("Hello, World!".getBytes(), 1);
+ 
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    send(byte[] data, + int messageType)
    +
    +
    Sends a message to a message queue.
    +
    +
    +
    +
    +
    +

    Methods inherited from interface java.lang.AutoCloseable

    +close
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      send

      +
      void send(byte[] data, + int messageType) + throws IOException
      +
      Sends a message to a message queue.
      +
      +
      Parameters:
      +
      data - the message data
      +
      messageType - the message type
      +
      Throws:
      +
      IOException - if an I/O error occurs
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/producer/class-use/DefaultMessageProducer.html b/docs/io/github/elimelt/pmqueue/producer/class-use/DefaultMessageProducer.html new file mode 100644 index 0000000..d42a2b4 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/producer/class-use/DefaultMessageProducer.html @@ -0,0 +1,62 @@ + + + + +Uses of Class io.github.elimelt.pmqueue.producer.DefaultMessageProducer (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
io.github.elimelt.pmqueue.producer.DefaultMessageProducer

+
+No usage of io.github.elimelt.pmqueue.producer.DefaultMessageProducer
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/producer/class-use/MessageProducer.html b/docs/io/github/elimelt/pmqueue/producer/class-use/MessageProducer.html new file mode 100644 index 0000000..e422100 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/producer/class-use/MessageProducer.html @@ -0,0 +1,89 @@ + + + + +Uses of Interface io.github.elimelt.pmqueue.producer.MessageProducer (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
io.github.elimelt.pmqueue.producer.MessageProducer

+
+
Packages that use MessageProducer
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/producer/package-summary.html b/docs/io/github/elimelt/pmqueue/producer/package-summary.html new file mode 100644 index 0000000..f5e5976 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/producer/package-summary.html @@ -0,0 +1,121 @@ + + + + +io.github.elimelt.pmqueue.producer (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package io.github.elimelt.pmqueue.producer

+
+
+
package io.github.elimelt.pmqueue.producer
+
+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/producer/package-tree.html b/docs/io/github/elimelt/pmqueue/producer/package-tree.html new file mode 100644 index 0000000..d3d9f97 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/producer/package-tree.html @@ -0,0 +1,86 @@ + + + + +io.github.elimelt.pmqueue.producer Class Hierarchy (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package io.github.elimelt.pmqueue.producer

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/io/github/elimelt/pmqueue/producer/package-use.html b/docs/io/github/elimelt/pmqueue/producer/package-use.html new file mode 100644 index 0000000..f807882 --- /dev/null +++ b/docs/io/github/elimelt/pmqueue/producer/package-use.html @@ -0,0 +1,86 @@ + + + + +Uses of Package io.github.elimelt.pmqueue.producer (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
io.github.elimelt.pmqueue.producer

+
+ +
+
Package
+
Description
+ +
 
+
+
+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/legal/ADDITIONAL_LICENSE_INFO b/docs/legal/ADDITIONAL_LICENSE_INFO new file mode 100644 index 0000000..ff700cd --- /dev/null +++ b/docs/legal/ADDITIONAL_LICENSE_INFO @@ -0,0 +1,37 @@ + ADDITIONAL INFORMATION ABOUT LICENSING + +Certain files distributed by Oracle America, Inc. and/or its affiliates are +subject to the following clarification and special exception to the GPLv2, +based on the GNU Project exception for its Classpath libraries, known as the +GNU Classpath Exception. + +Note that Oracle includes multiple, independent programs in this software +package. Some of those programs are provided under licenses deemed +incompatible with the GPLv2 by the Free Software Foundation and others. +For example, the package includes programs licensed under the Apache +License, Version 2.0 and may include FreeType. Such programs are licensed +to you under their original licenses. + +Oracle facilitates your further distribution of this package by adding the +Classpath Exception to the necessary parts of its GPLv2 code, which permits +you to use that code in combination with other independent modules not +licensed under the GPLv2. However, note that this would not permit you to +commingle code under an incompatible license with Oracle's GPLv2 licensed +code by, for example, cutting and pasting such code into a file also +containing Oracle's GPLv2 licensed code and then distributing the result. + +Additionally, if you were to remove the Classpath Exception from any of the +files to which it applies and distribute the result, you would likely be +required to license some or all of the other code in that distribution under +the GPLv2 as well, and since the GPLv2 is incompatible with the license terms +of some items included in the distribution by Oracle, removing the Classpath +Exception could therefore effectively compromise your ability to further +distribute the package. + +Failing to distribute notices associated with some files may also create +unexpected legal consequences. + +Proceed with caution and we recommend that you obtain the advice of a lawyer +skilled in open source matters before removing the Classpath Exception or +making modifications to this package which may subsequently be redistributed +and/or involve the use of third party software. diff --git a/docs/legal/ASSEMBLY_EXCEPTION b/docs/legal/ASSEMBLY_EXCEPTION new file mode 100644 index 0000000..4296666 --- /dev/null +++ b/docs/legal/ASSEMBLY_EXCEPTION @@ -0,0 +1,27 @@ + +OPENJDK ASSEMBLY EXCEPTION + +The OpenJDK source code made available by Oracle America, Inc. (Oracle) at +openjdk.org ("OpenJDK Code") is distributed under the terms of the GNU +General Public License version 2 +only ("GPL2"), with the following clarification and special exception. + + Linking this OpenJDK Code statically or dynamically with other code + is making a combined work based on this library. Thus, the terms + and conditions of GPL2 cover the whole combination. + + As a special exception, Oracle gives you permission to link this + OpenJDK Code with certain code licensed by Oracle as indicated at + https://openjdk.org/legal/exception-modules-2007-05-08.html + ("Designated Exception Modules") to produce an executable, + regardless of the license terms of the Designated Exception Modules, + and to copy and distribute the resulting executable under GPL2, + provided that the Designated Exception Modules continue to be + governed by the licenses under which they were offered by Oracle. + +As such, it allows licensees and sublicensees of Oracle's GPL2 OpenJDK Code +to build an executable that includes those portions of necessary code that +Oracle could not provide under GPL2 (or that Oracle has provided under GPL2 +with the Classpath exception). If you modify or add to the OpenJDK code, +that new GPL2 code may still be combined with Designated Exception Modules +if the new code is made subject to this exception by its copyright holder. diff --git a/docs/legal/LICENSE b/docs/legal/LICENSE new file mode 100644 index 0000000..8b400c7 --- /dev/null +++ b/docs/legal/LICENSE @@ -0,0 +1,347 @@ +The GNU General Public License (GPL) + +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share +and change it. By contrast, the GNU General Public License is intended to +guarantee your freedom to share and change free software--to make sure the +software is free for all its users. This General Public License applies to +most of the Free Software Foundation's software and to any other program whose +authors commit to using it. (Some other Free Software Foundation software is +covered by the GNU Library General Public License instead.) You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom to +distribute copies of free software (and charge for this service if you wish), +that you receive source code or can get it if you want it, that you can change +the software or use pieces of it in new free programs; and that you know you +can do these things. + +To protect your rights, we need to make restrictions that forbid anyone to deny +you these rights or to ask you to surrender the rights. These restrictions +translate to certain responsibilities for you if you distribute copies of the +software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or for +a fee, you must give the recipients all the rights that you have. You must +make sure that they, too, receive or can get the source code. And you must +show them these terms so they know their rights. + +We protect your rights with two steps: (1) copyright the software, and (2) +offer you this license which gives you legal permission to copy, distribute +and/or modify the software. + +Also, for each author's protection and ours, we want to make certain that +everyone understands that there is no warranty for this free software. If the +software is modified by someone else and passed on, we want its recipients to +know that what they have is not the original, so that any problems introduced +by others will not reflect on the original authors' reputations. + +Finally, any free program is threatened constantly by software patents. We +wish to avoid the danger that redistributors of a free program will +individually obtain patent licenses, in effect making the program proprietary. +To prevent this, we have made it clear that any patent must be licensed for +everyone's free use or not licensed at all. + +The precise terms and conditions for copying, distribution and modification +follow. + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. This License applies to any program or other work which contains a notice +placed by the copyright holder saying it may be distributed under the terms of +this General Public License. The "Program", below, refers to any such program +or work, and a "work based on the Program" means either the Program or any +derivative work under copyright law: that is to say, a work containing the +Program or a portion of it, either verbatim or with modifications and/or +translated into another language. (Hereinafter, translation is included +without limitation in the term "modification".) Each licensee is addressed as +"you". + +Activities other than copying, distribution and modification are not covered by +this License; they are outside its scope. The act of running the Program is +not restricted, and the output from the Program is covered only if its contents +constitute a work based on the Program (independent of having been made by +running the Program). Whether that is true depends on what the Program does. + +1. You may copy and distribute verbatim copies of the Program's source code as +you receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice and +disclaimer of warranty; keep intact all the notices that refer to this License +and to the absence of any warranty; and give any other recipients of the +Program a copy of this License along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you may +at your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Program or any portion of it, thus +forming a work based on the Program, and copy and distribute such modifications +or work under the terms of Section 1 above, provided that you also meet all of +these conditions: + + a) You must cause the modified files to carry prominent notices stating + that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in whole or + in part contains or is derived from the Program or any part thereof, to be + licensed as a whole at no charge to all third parties under the terms of + this License. + + c) If the modified program normally reads commands interactively when run, + you must cause it, when started running for such interactive use in the + most ordinary way, to print or display an announcement including an + appropriate copyright notice and a notice that there is no warranty (or + else, saying that you provide a warranty) and that users may redistribute + the program under these conditions, and telling the user how to view a copy + of this License. (Exception: if the Program itself is interactive but does + not normally print such an announcement, your work based on the Program is + not required to print an announcement.) + +These requirements apply to the modified work as a whole. If identifiable +sections of that work are not derived from the Program, and can be reasonably +considered independent and separate works in themselves, then this License, and +its terms, do not apply to those sections when you distribute them as separate +works. But when you distribute the same sections as part of a whole which is a +work based on the Program, the distribution of the whole must be on the terms +of this License, whose permissions for other licensees extend to the entire +whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest your +rights to work written entirely by you; rather, the intent is to exercise the +right to control the distribution of derivative or collective works based on +the Program. + +In addition, mere aggregation of another work not based on the Program with the +Program (or with a work based on the Program) on a volume of a storage or +distribution medium does not bring the other work under the scope of this +License. + +3. You may copy and distribute the Program (or a work based on it, under +Section 2) in object code or executable form under the terms of Sections 1 and +2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable source + code, which must be distributed under the terms of Sections 1 and 2 above + on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three years, to + give any third party, for a charge no more than your cost of physically + performing source distribution, a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of Sections 1 + and 2 above on a medium customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer to + distribute corresponding source code. (This alternative is allowed only + for noncommercial distribution and only if you received the program in + object code or executable form with such an offer, in accord with + Subsection b above.) + +The source code for a work means the preferred form of the work for making +modifications to it. For an executable work, complete source code means all +the source code for all modules it contains, plus any associated interface +definition files, plus the scripts used to control compilation and installation +of the executable. However, as a special exception, the source code +distributed need not include anything that is normally distributed (in either +source or binary form) with the major components (compiler, kernel, and so on) +of the operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the source +code from the same place counts as distribution of the source code, even though +third parties are not compelled to copy the source along with the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except as +expressly provided under this License. Any attempt otherwise to copy, modify, +sublicense or distribute the Program is void, and will automatically terminate +your rights under this License. However, parties who have received copies, or +rights, from you under this License will not have their licenses terminated so +long as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed it. +However, nothing else grants you permission to modify or distribute the Program +or its derivative works. These actions are prohibited by law if you do not +accept this License. Therefore, by modifying or distributing the Program (or +any work based on the Program), you indicate your acceptance of this License to +do so, and all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the Program), +the recipient automatically receives a license from the original licensor to +copy, distribute or modify the Program subject to these terms and conditions. +You may not impose any further restrictions on the recipients' exercise of the +rights granted herein. You are not responsible for enforcing compliance by +third parties to this License. + +7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), conditions +are imposed on you (whether by court order, agreement or otherwise) that +contradict the conditions of this License, they do not excuse you from the +conditions of this License. If you cannot distribute so as to satisfy +simultaneously your obligations under this License and any other pertinent +obligations, then as a consequence you may not distribute the Program at all. +For example, if a patent license would not permit royalty-free redistribution +of the Program by all those who receive copies directly or indirectly through +you, then the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply and +the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents or +other property right claims or to contest validity of any such claims; this +section has the sole purpose of protecting the integrity of the free software +distribution system, which is implemented by public license practices. Many +people have made generous contributions to the wide range of software +distributed through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing to +distribute software through any other system and a licensee cannot impose that +choice. + +This section is intended to make thoroughly clear what is believed to be a +consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain +countries either by patents or by copyrighted interfaces, the original +copyright holder who places the Program under this License may add an explicit +geographical distribution limitation excluding those countries, so that +distribution is permitted only in or among countries not thus excluded. In +such case, this License incorporates the limitation as if written in the body +of this License. + +9. The Free Software Foundation may publish revised and/or new versions of the +General Public License from time to time. Such new versions will be similar in +spirit to the present version, but may differ in detail to address new problems +or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any later +version", you have the option of following the terms and conditions either of +that version or of any later version published by the Free Software Foundation. +If the Program does not specify a version number of this License, you may +choose any version ever published by the Free Software Foundation. + +10. If you wish to incorporate parts of the Program into other free programs +whose distribution conditions are different, write to the author to ask for +permission. For software which is copyrighted by the Free Software Foundation, +write to the Free Software Foundation; we sometimes make exceptions for this. +Our decision will be guided by the two goals of preserving the free status of +all derivatives of our free software and of promoting the sharing and reuse of +software generally. + +NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR +THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE +STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE +PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, +YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL +ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE +PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR +INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA +BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER +OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +END OF TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible +use to the public, the best way to achieve this is to make it free software +which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach +them to the start of each source file to most effectively convey the exclusion +of warranty; and each file should have at least the "copyright" line and a +pointer to where the full notice is found. + + One line to give the program's name and a brief idea of what it does. + + Copyright (C) + + This program is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by the Free + Software Foundation; either version 2 of the License, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this when it +starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author Gnomovision comes + with ABSOLUTELY NO WARRANTY; for details type 'show w'. This is free + software, and you are welcome to redistribute it under certain conditions; + type 'show c' for details. + +The hypothetical commands 'show w' and 'show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may be +called something other than 'show w' and 'show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your school, +if any, to sign a "copyright disclaimer" for the program, if necessary. Here +is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + 'Gnomovision' (which makes passes at compilers) written by James Hacker. + + signature of Ty Coon, 1 April 1989 + + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General Public +License instead of this License. + + +"CLASSPATH" EXCEPTION TO THE GPL + +Certain source files distributed by Oracle America and/or its affiliates are +subject to the following clarification and special exception to the GPL, but +only where Oracle has expressly included in the particular source file's header +the words "Oracle designates this particular file as subject to the "Classpath" +exception as provided by Oracle in the LICENSE file that accompanied this code." + + Linking this library statically or dynamically with other modules is making + a combined work based on this library. Thus, the terms and conditions of + the GNU General Public License cover the whole combination. + + As a special exception, the copyright holders of this library give you + permission to link this library with independent modules to produce an + executable, regardless of the license terms of these independent modules, + and to copy and distribute the resulting executable under terms of your + choice, provided that you also meet, for each linked independent module, + the terms and conditions of the license of that module. An independent + module is a module which is not derived from or based on this library. If + you modify this library, you may extend this exception to your version of + the library, but you are not obligated to do so. If you do not wish to do + so, delete this exception statement from your version. diff --git a/docs/legal/jquery.md b/docs/legal/jquery.md new file mode 100644 index 0000000..d468b31 --- /dev/null +++ b/docs/legal/jquery.md @@ -0,0 +1,72 @@ +## jQuery v3.6.1 + +### jQuery License +``` +jQuery v 3.6.1 +Copyright OpenJS Foundation and other contributors, https://openjsf.org/ + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +****************************************** + +The jQuery JavaScript Library v3.6.1 also includes Sizzle.js + +Sizzle.js includes the following license: + +Copyright JS Foundation and other contributors, https://js.foundation/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/sizzle + +The following license applies to all parts of this software except as +documented below: + +==== + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +********************* + +``` diff --git a/docs/legal/jqueryUI.md b/docs/legal/jqueryUI.md new file mode 100644 index 0000000..8bda9d7 --- /dev/null +++ b/docs/legal/jqueryUI.md @@ -0,0 +1,49 @@ +## jQuery UI v1.13.2 + +### jQuery UI License +``` +Copyright jQuery Foundation and other contributors, https://jquery.org/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/jquery-ui + +The following license applies to all parts of this software except as +documented below: + +==== + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +==== + +Copyright and related rights for sample code are waived via CC0. Sample +code is defined as all source code contained within the demos directory. + +CC0: http://creativecommons.org/publicdomain/zero/1.0/ + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +``` diff --git a/docs/link.svg b/docs/link.svg new file mode 100644 index 0000000..7ccc5ed --- /dev/null +++ b/docs/link.svg @@ -0,0 +1,31 @@ + + + + + + + + diff --git a/docs/member-search-index.js b/docs/member-search-index.js new file mode 100644 index 0000000..23d0ddc --- /dev/null +++ b/docs/member-search-index.js @@ -0,0 +1 @@ +memberSearchIndex = [{"p":"io.github.elimelt.pmqueue","c":"QueueConfig.Builder","l":"batchThreshold(int)"},{"p":"io.github.elimelt.pmqueue.core","c":"PersistentMessageQueue","l":"BLOCK_HEADER_SIZE"},{"p":"io.github.elimelt.pmqueue","c":"QueueConfig.Builder","l":"build()"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory.CustomQueueBuilder","l":"build()"},{"p":"io.github.elimelt.pmqueue","c":"QueueConfig.Builder","l":"Builder()","u":"%3Cinit%3E()"},{"p":"io.github.elimelt.pmqueue","c":"QueueConfig.Builder","l":"checksumEnabled(boolean)"},{"p":"io.github.elimelt.pmqueue.consumer","c":"DefaultMessageConsumer","l":"close()"},{"p":"io.github.elimelt.pmqueue.core","c":"PersistentMessageQueue","l":"close()"},{"p":"io.github.elimelt.pmqueue.producer","c":"DefaultMessageProducer","l":"close()"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory","l":"createDebugQueue(String)","u":"createDebugQueue(java.lang.String)"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory","l":"createDurableQueue(String)","u":"createDurableQueue(java.lang.String)"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory","l":"createHighThroughputQueue(String)","u":"createHighThroughputQueue(java.lang.String)"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory","l":"createLargeMessageQueue(String)","u":"createLargeMessageQueue(java.lang.String)"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory","l":"createLowMemoryQueue(String)","u":"createLowMemoryQueue(java.lang.String)"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory","l":"createQueue(String)","u":"createQueue(java.lang.String)"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory.QueuePreset","l":"createQueue(String)","u":"createQueue(java.lang.String)"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory.CustomQueueBuilder","l":"CustomQueueBuilder()","u":"%3Cinit%3E()"},{"p":"io.github.elimelt.pmqueue","c":"QueueConfig.Builder","l":"debugEnabled(boolean)"},{"p":"io.github.elimelt.pmqueue","c":"QueueConfig.Builder","l":"defaultBufferSize(int)"},{"p":"io.github.elimelt.pmqueue.consumer","c":"DefaultMessageConsumer","l":"DefaultMessageConsumer(MessageQueue, Consumer, int, long)","u":"%3Cinit%3E(io.github.elimelt.pmqueue.MessageQueue,java.util.function.Consumer,int,long)"},{"p":"io.github.elimelt.pmqueue.producer","c":"DefaultMessageProducer","l":"DefaultMessageProducer(MessageQueue)","u":"%3Cinit%3E(io.github.elimelt.pmqueue.MessageQueue)"},{"p":"io.github.elimelt.pmqueue.message","c":"MessageSerializer","l":"deserialize(byte[])"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory.QueuePreset","l":"DURABLE"},{"p":"io.github.elimelt.pmqueue","c":"QueueConfig.Builder","l":"filePath(String)","u":"filePath(java.lang.String)"},{"p":"io.github.elimelt.pmqueue.core","c":"PersistentMessageQueue","l":"flushBatch()"},{"p":"io.github.elimelt.pmqueue","c":"QueueConfig","l":"getBatchThreshold()"},{"p":"io.github.elimelt.pmqueue.consumer","c":"DefaultMessageConsumer","l":"getConsumerThread()"},{"p":"io.github.elimelt.pmqueue.message","c":"Message","l":"getData()"},{"p":"io.github.elimelt.pmqueue","c":"QueueConfig","l":"getDefaultBufferSize()"},{"p":"io.github.elimelt.pmqueue","c":"QueueConfig","l":"getFilePath()"},{"p":"io.github.elimelt.pmqueue","c":"QueueConfig","l":"getInitialFileSize()"},{"p":"io.github.elimelt.pmqueue","c":"QueueConfig","l":"getMaxBufferSize()"},{"p":"io.github.elimelt.pmqueue","c":"QueueConfig","l":"getMaxFileSize()"},{"p":"io.github.elimelt.pmqueue.message","c":"Message","l":"getMessageType()"},{"p":"io.github.elimelt.pmqueue.consumer","c":"DefaultMessageConsumer","l":"getRunning()"},{"p":"io.github.elimelt.pmqueue.message","c":"Message","l":"getTimestamp()"},{"p":"io.github.elimelt.pmqueue.message","c":"Message","l":"hashCode()"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory.QueuePreset","l":"HIGH_THROUGHPUT"},{"p":"io.github.elimelt.pmqueue","c":"QueueConfig.Builder","l":"initialFileSize(int)"},{"p":"io.github.elimelt.pmqueue","c":"QueueConfig","l":"isChecksumEnabled()"},{"p":"io.github.elimelt.pmqueue","c":"QueueConfig","l":"isDebugEnabled()"},{"p":"io.github.elimelt.pmqueue.core","c":"PersistentMessageQueue","l":"isEmpty()"},{"p":"io.github.elimelt.pmqueue","c":"MessageQueue","l":"isEmpty()"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory.QueuePreset","l":"LOW_MEMORY"},{"p":"io.github.elimelt.pmqueue","c":"QueueConfig.Builder","l":"maxBufferSize(int)"},{"p":"io.github.elimelt.pmqueue","c":"QueueConfig.Builder","l":"maxFileSize(long)"},{"p":"io.github.elimelt.pmqueue.message","c":"Message","l":"Message(byte[], int)","u":"%3Cinit%3E(byte[],int)"},{"p":"io.github.elimelt.pmqueue.core","c":"PersistentMessageQueue","l":"offer(Message)","u":"offer(io.github.elimelt.pmqueue.message.Message)"},{"p":"io.github.elimelt.pmqueue","c":"MessageQueue","l":"offer(Message)","u":"offer(io.github.elimelt.pmqueue.message.Message)"},{"p":"io.github.elimelt.pmqueue.core","c":"PersistentMessageQueue","l":"PAGE_SIZE"},{"p":"io.github.elimelt.pmqueue.core","c":"PersistentMessageQueue","l":"PersistentMessageQueue(QueueConfig)","u":"%3Cinit%3E(io.github.elimelt.pmqueue.QueueConfig)"},{"p":"io.github.elimelt.pmqueue.core","c":"PersistentMessageQueue","l":"PersistentMessageQueue(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"io.github.elimelt.pmqueue.core","c":"PersistentMessageQueue","l":"poll()"},{"p":"io.github.elimelt.pmqueue","c":"MessageQueue","l":"poll()"},{"p":"io.github.elimelt.pmqueue.core","c":"PersistentMessageQueue","l":"QUEUE_HEADER_SIZE"},{"p":"io.github.elimelt.pmqueue.producer","c":"DefaultMessageProducer","l":"send(byte[], int)","u":"send(byte[],int)"},{"p":"io.github.elimelt.pmqueue.producer","c":"MessageProducer","l":"send(byte[], int)","u":"send(byte[],int)"},{"p":"io.github.elimelt.pmqueue.message","c":"MessageSerializer","l":"serialize(Message)","u":"serialize(io.github.elimelt.pmqueue.message.Message)"},{"p":"io.github.elimelt.pmqueue.consumer","c":"DefaultMessageConsumer","l":"start()"},{"p":"io.github.elimelt.pmqueue.consumer","c":"MessageConsumer","l":"start()"},{"p":"io.github.elimelt.pmqueue.consumer","c":"DefaultMessageConsumer","l":"stop()"},{"p":"io.github.elimelt.pmqueue.consumer","c":"MessageConsumer","l":"stop()"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory.QueuePreset","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory.QueuePreset","l":"values()"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory.CustomQueueBuilder","l":"withBatchThreshold(int)"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory.CustomQueueBuilder","l":"withChecksumEnabled(boolean)"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory.CustomQueueBuilder","l":"withDebugEnabled(boolean)"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory.CustomQueueBuilder","l":"withDefaultBufferSize(int)"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory.CustomQueueBuilder","l":"withFilePath(String)","u":"withFilePath(java.lang.String)"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory.CustomQueueBuilder","l":"withMaxBufferSize(int)"},{"p":"io.github.elimelt.pmqueue","c":"QueueFactory.CustomQueueBuilder","l":"withMaxFileSize(long)"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/module-search-index.js b/docs/module-search-index.js new file mode 100644 index 0000000..0d59754 --- /dev/null +++ b/docs/module-search-index.js @@ -0,0 +1 @@ +moduleSearchIndex = [];updateSearchResults(); \ No newline at end of file diff --git a/docs/overview-summary.html b/docs/overview-summary.html new file mode 100644 index 0000000..29c0e7b --- /dev/null +++ b/docs/overview-summary.html @@ -0,0 +1,26 @@ + + + + +pmqueue 1.0-SNAPSHOT API + + + + + + + + + + + +
+ +

index.html

+
+ + diff --git a/docs/overview-tree.html b/docs/overview-tree.html new file mode 100644 index 0000000..cb943ef --- /dev/null +++ b/docs/overview-tree.html @@ -0,0 +1,114 @@ + + + + +Class Hierarchy (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For All Packages

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Enum Hierarchy

+ +
+
+
+
+ +
+
+
+ + diff --git a/docs/package-search-index.js b/docs/package-search-index.js new file mode 100644 index 0000000..28b3afe --- /dev/null +++ b/docs/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","u":"allpackages-index.html"},{"l":"io.github.elimelt.pmqueue"},{"l":"io.github.elimelt.pmqueue.consumer"},{"l":"io.github.elimelt.pmqueue.core"},{"l":"io.github.elimelt.pmqueue.message"},{"l":"io.github.elimelt.pmqueue.producer"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/resources/glass.png b/docs/resources/glass.png new file mode 100644 index 0000000000000000000000000000000000000000..a7f591f467a1c0c949bbc510156a0c1afb860a6e GIT binary patch literal 499 zcmVJoRsvExf%rEN>jUL}qZ_~k#FbE+Q;{`;0FZwVNX2n-^JoI; zP;4#$8DIy*Yk-P>VN(DUKmPse7mx+ExD4O|;?E5D0Z5($mjO3`*anwQU^s{ZDK#Lz zj>~{qyaIx5K!t%=G&2IJNzg!ChRpyLkO7}Ry!QaotAHAMpbB3AF(}|_f!G-oI|uK6 z`id_dumai5K%C3Y$;tKS_iqMPHg<*|-@e`liWLAggVM!zAP#@l;=c>S03;{#04Z~5 zN_+ss=Yg6*hTr59mzMwZ@+l~q!+?ft!fF66AXT#wWavHt30bZWFCK%!BNk}LN?0Hg z1VF_nfs`Lm^DjYZ1(1uD0u4CSIr)XAaqW6IT{!St5~1{i=i}zAy76p%_|w8rh@@c0Axr!ns=D-X+|*sY6!@wacG9%)Qn*O zl0sa739kT-&_?#oVxXF6tOnqTD)cZ}2vi$`ZU8RLAlo8=_z#*P3xI~i!lEh+Pdu-L zx{d*wgjtXbnGX_Yf@Tc7Q3YhLhPvc8noGJs2DA~1DySiA&6V{5JzFt ojAY1KXm~va;tU{v7C?Xj0BHw!K;2aXV*mgE07*qoM6N<$f;4TDA^-pY literal 0 HcmV?d00001 diff --git a/docs/script-dir/jquery-3.6.1.min.js b/docs/script-dir/jquery-3.6.1.min.js new file mode 100644 index 0000000..2c69bc9 --- /dev/null +++ b/docs/script-dir/jquery-3.6.1.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,y=n.hasOwnProperty,a=y.toString,l=a.call(Object),v={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&v(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!y||!y.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ve(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ye(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ve(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],y=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&y.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||y.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||y.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||y.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||y.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||y.push(".#.+[+~]"),e.querySelectorAll("\\\f"),y.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&y.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&y.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&y.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),y.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),y=y.length&&new RegExp(y.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),v=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&v(p,e)?-1:t==C||t.ownerDocument==p&&v(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!y||!y.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),v.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",v.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",v.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ye(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ve(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),v.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(v.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return B(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=_e(v.pixelPosition,function(e,t){if(t)return t=Be(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return B(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",options:{classes:{},disabled:!1,create:null},_createWidget:function(t,e){e=x(e||this.defaultElement||this)[0],this.element=x(e),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=x(),this.hoverable=x(),this.focusable=x(),this.classesElementLookup={},e!==this&&(x.data(e,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===e&&this.destroy()}}),this.document=x(e.style?e.ownerDocument:e.document||e),this.window=x(this.document[0].defaultView||this.document[0].parentWindow)),this.options=x.widget.extend({},this.options,this._getCreateOptions(),t),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:x.noop,_create:x.noop,_init:x.noop,destroy:function(){var i=this;this._destroy(),x.each(this.classesElementLookup,function(t,e){i._removeClass(e,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:x.noop,widget:function(){return this.element},option:function(t,e){var i,s,n,o=t;if(0===arguments.length)return x.widget.extend({},this.options);if("string"==typeof t)if(o={},t=(i=t.split(".")).shift(),i.length){for(s=o[t]=x.widget.extend({},this.options[t]),n=0;n
"),i=e.children()[0];return x("body").append(e),t=i.offsetWidth,e.css("overflow","scroll"),t===(i=i.offsetWidth)&&(i=e[0].clientWidth),e.remove(),s=t-i},getScrollInfo:function(t){var e=t.isWindow||t.isDocument?"":t.element.css("overflow-x"),i=t.isWindow||t.isDocument?"":t.element.css("overflow-y"),e="scroll"===e||"auto"===e&&t.widthC(E(s),E(n))?o.important="horizontal":o.important="vertical",c.using.call(this,t,o)}),l.offset(x.extend(u,{using:t}))})},x.ui.position={fit:{left:function(t,e){var i=e.within,s=i.isWindow?i.scrollLeft:i.offset.left,n=i.width,o=t.left-e.collisionPosition.marginLeft,l=s-o,a=o+e.collisionWidth-n-s;e.collisionWidth>n?0n?0",delay:300,options:{icons:{submenu:"ui-icon-caret-1-e"},items:"> *",menus:"ul",position:{my:"left top",at:"right top"},role:"menu",blur:null,focus:null,select:null},_create:function(){this.activeMenu=this.element,this.mouseHandled=!1,this.lastMousePosition={x:null,y:null},this.element.uniqueId().attr({role:this.options.role,tabIndex:0}),this._addClass("ui-menu","ui-widget ui-widget-content"),this._on({"mousedown .ui-menu-item":function(t){t.preventDefault(),this._activateItem(t)},"click .ui-menu-item":function(t){var e=x(t.target),i=x(x.ui.safeActiveElement(this.document[0]));!this.mouseHandled&&e.not(".ui-state-disabled").length&&(this.select(t),t.isPropagationStopped()||(this.mouseHandled=!0),e.has(".ui-menu").length?this.expand(t):!this.element.is(":focus")&&i.closest(".ui-menu").length&&(this.element.trigger("focus",[!0]),this.active&&1===this.active.parents(".ui-menu").length&&clearTimeout(this.timer)))},"mouseenter .ui-menu-item":"_activateItem","mousemove .ui-menu-item":"_activateItem",mouseleave:"collapseAll","mouseleave .ui-menu":"collapseAll",focus:function(t,e){var i=this.active||this._menuItems().first();e||this.focus(t,i)},blur:function(t){this._delay(function(){x.contains(this.element[0],x.ui.safeActiveElement(this.document[0]))||this.collapseAll(t)})},keydown:"_keydown"}),this.refresh(),this._on(this.document,{click:function(t){this._closeOnDocumentClick(t)&&this.collapseAll(t,!0),this.mouseHandled=!1}})},_activateItem:function(t){var e,i;this.previousFilter||t.clientX===this.lastMousePosition.x&&t.clientY===this.lastMousePosition.y||(this.lastMousePosition={x:t.clientX,y:t.clientY},e=x(t.target).closest(".ui-menu-item"),i=x(t.currentTarget),e[0]===i[0]&&(i.is(".ui-state-active")||(this._removeClass(i.siblings().children(".ui-state-active"),null,"ui-state-active"),this.focus(t,i))))},_destroy:function(){var t=this.element.find(".ui-menu-item").removeAttr("role aria-disabled").children(".ui-menu-item-wrapper").removeUniqueId().removeAttr("tabIndex role aria-haspopup");this.element.removeAttr("aria-activedescendant").find(".ui-menu").addBack().removeAttr("role aria-labelledby aria-expanded aria-hidden aria-disabled tabIndex").removeUniqueId().show(),t.children().each(function(){var t=x(this);t.data("ui-menu-submenu-caret")&&t.remove()})},_keydown:function(t){var e,i,s,n=!0;switch(t.keyCode){case x.ui.keyCode.PAGE_UP:this.previousPage(t);break;case x.ui.keyCode.PAGE_DOWN:this.nextPage(t);break;case x.ui.keyCode.HOME:this._move("first","first",t);break;case x.ui.keyCode.END:this._move("last","last",t);break;case x.ui.keyCode.UP:this.previous(t);break;case x.ui.keyCode.DOWN:this.next(t);break;case x.ui.keyCode.LEFT:this.collapse(t);break;case x.ui.keyCode.RIGHT:this.active&&!this.active.is(".ui-state-disabled")&&this.expand(t);break;case x.ui.keyCode.ENTER:case x.ui.keyCode.SPACE:this._activate(t);break;case x.ui.keyCode.ESCAPE:this.collapse(t);break;default:e=this.previousFilter||"",s=n=!1,i=96<=t.keyCode&&t.keyCode<=105?(t.keyCode-96).toString():String.fromCharCode(t.keyCode),clearTimeout(this.filterTimer),i===e?s=!0:i=e+i,e=this._filterMenuItems(i),(e=s&&-1!==e.index(this.active.next())?this.active.nextAll(".ui-menu-item"):e).length||(i=String.fromCharCode(t.keyCode),e=this._filterMenuItems(i)),e.length?(this.focus(t,e),this.previousFilter=i,this.filterTimer=this._delay(function(){delete this.previousFilter},1e3)):delete this.previousFilter}n&&t.preventDefault()},_activate:function(t){this.active&&!this.active.is(".ui-state-disabled")&&(this.active.children("[aria-haspopup='true']").length?this.expand(t):this.select(t))},refresh:function(){var t,e,s=this,n=this.options.icons.submenu,i=this.element.find(this.options.menus);this._toggleClass("ui-menu-icons",null,!!this.element.find(".ui-icon").length),e=i.filter(":not(.ui-menu)").hide().attr({role:this.options.role,"aria-hidden":"true","aria-expanded":"false"}).each(function(){var t=x(this),e=t.prev(),i=x("").data("ui-menu-submenu-caret",!0);s._addClass(i,"ui-menu-icon","ui-icon "+n),e.attr("aria-haspopup","true").prepend(i),t.attr("aria-labelledby",e.attr("id"))}),this._addClass(e,"ui-menu","ui-widget ui-widget-content ui-front"),(t=i.add(this.element).find(this.options.items)).not(".ui-menu-item").each(function(){var t=x(this);s._isDivider(t)&&s._addClass(t,"ui-menu-divider","ui-widget-content")}),i=(e=t.not(".ui-menu-item, .ui-menu-divider")).children().not(".ui-menu").uniqueId().attr({tabIndex:-1,role:this._itemRole()}),this._addClass(e,"ui-menu-item")._addClass(i,"ui-menu-item-wrapper"),t.filter(".ui-state-disabled").attr("aria-disabled","true"),this.active&&!x.contains(this.element[0],this.active[0])&&this.blur()},_itemRole:function(){return{menu:"menuitem",listbox:"option"}[this.options.role]},_setOption:function(t,e){var i;"icons"===t&&(i=this.element.find(".ui-menu-icon"),this._removeClass(i,null,this.options.icons.submenu)._addClass(i,null,e.submenu)),this._super(t,e)},_setOptionDisabled:function(t){this._super(t),this.element.attr("aria-disabled",String(t)),this._toggleClass(null,"ui-state-disabled",!!t)},focus:function(t,e){var i;this.blur(t,t&&"focus"===t.type),this._scrollIntoView(e),this.active=e.first(),i=this.active.children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),this.options.role&&this.element.attr("aria-activedescendant",i.attr("id")),i=this.active.parent().closest(".ui-menu-item").children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),t&&"keydown"===t.type?this._close():this.timer=this._delay(function(){this._close()},this.delay),(i=e.children(".ui-menu")).length&&t&&/^mouse/.test(t.type)&&this._startOpening(i),this.activeMenu=e.parent(),this._trigger("focus",t,{item:e})},_scrollIntoView:function(t){var e,i,s;this._hasScroll()&&(i=parseFloat(x.css(this.activeMenu[0],"borderTopWidth"))||0,s=parseFloat(x.css(this.activeMenu[0],"paddingTop"))||0,e=t.offset().top-this.activeMenu.offset().top-i-s,i=this.activeMenu.scrollTop(),s=this.activeMenu.height(),t=t.outerHeight(),e<0?this.activeMenu.scrollTop(i+e):s",options:{appendTo:null,autoFocus:!1,delay:300,minLength:1,position:{my:"left top",at:"left bottom",collision:"none"},source:null,change:null,close:null,focus:null,open:null,response:null,search:null,select:null},requestIndex:0,pending:0,liveRegionTimer:null,_create:function(){var i,s,n,t=this.element[0].nodeName.toLowerCase(),e="textarea"===t,t="input"===t;this.isMultiLine=e||!t&&this._isContentEditable(this.element),this.valueMethod=this.element[e||t?"val":"text"],this.isNewMenu=!0,this._addClass("ui-autocomplete-input"),this.element.attr("autocomplete","off"),this._on(this.element,{keydown:function(t){if(this.element.prop("readOnly"))s=n=i=!0;else{s=n=i=!1;var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:i=!0,this._move("previousPage",t);break;case e.PAGE_DOWN:i=!0,this._move("nextPage",t);break;case e.UP:i=!0,this._keyEvent("previous",t);break;case e.DOWN:i=!0,this._keyEvent("next",t);break;case e.ENTER:this.menu.active&&(i=!0,t.preventDefault(),this.menu.select(t));break;case e.TAB:this.menu.active&&this.menu.select(t);break;case e.ESCAPE:this.menu.element.is(":visible")&&(this.isMultiLine||this._value(this.term),this.close(t),t.preventDefault());break;default:s=!0,this._searchTimeout(t)}}},keypress:function(t){if(i)return i=!1,void(this.isMultiLine&&!this.menu.element.is(":visible")||t.preventDefault());if(!s){var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:this._move("previousPage",t);break;case e.PAGE_DOWN:this._move("nextPage",t);break;case e.UP:this._keyEvent("previous",t);break;case e.DOWN:this._keyEvent("next",t)}}},input:function(t){if(n)return n=!1,void t.preventDefault();this._searchTimeout(t)},focus:function(){this.selectedItem=null,this.previous=this._value()},blur:function(t){clearTimeout(this.searching),this.close(t),this._change(t)}}),this._initSource(),this.menu=x("
    ").appendTo(this._appendTo()).menu({role:null}).hide().attr({unselectable:"on"}).menu("instance"),this._addClass(this.menu.element,"ui-autocomplete","ui-front"),this._on(this.menu.element,{mousedown:function(t){t.preventDefault()},menufocus:function(t,e){var i,s;if(this.isNewMenu&&(this.isNewMenu=!1,t.originalEvent&&/^mouse/.test(t.originalEvent.type)))return this.menu.blur(),void this.document.one("mousemove",function(){x(t.target).trigger(t.originalEvent)});s=e.item.data("ui-autocomplete-item"),!1!==this._trigger("focus",t,{item:s})&&t.originalEvent&&/^key/.test(t.originalEvent.type)&&this._value(s.value),(i=e.item.attr("aria-label")||s.value)&&String.prototype.trim.call(i).length&&(clearTimeout(this.liveRegionTimer),this.liveRegionTimer=this._delay(function(){this.liveRegion.html(x("
    ").text(i))},100))},menuselect:function(t,e){var i=e.item.data("ui-autocomplete-item"),s=this.previous;this.element[0]!==x.ui.safeActiveElement(this.document[0])&&(this.element.trigger("focus"),this.previous=s,this._delay(function(){this.previous=s,this.selectedItem=i})),!1!==this._trigger("select",t,{item:i})&&this._value(i.value),this.term=this._value(),this.close(t),this.selectedItem=i}}),this.liveRegion=x("
    ",{role:"status","aria-live":"assertive","aria-relevant":"additions"}).appendTo(this.document[0].body),this._addClass(this.liveRegion,null,"ui-helper-hidden-accessible"),this._on(this.window,{beforeunload:function(){this.element.removeAttr("autocomplete")}})},_destroy:function(){clearTimeout(this.searching),this.element.removeAttr("autocomplete"),this.menu.element.remove(),this.liveRegion.remove()},_setOption:function(t,e){this._super(t,e),"source"===t&&this._initSource(),"appendTo"===t&&this.menu.element.appendTo(this._appendTo()),"disabled"===t&&e&&this.xhr&&this.xhr.abort()},_isEventTargetInWidget:function(t){var e=this.menu.element[0];return t.target===this.element[0]||t.target===e||x.contains(e,t.target)},_closeOnClickOutside:function(t){this._isEventTargetInWidget(t)||this.close()},_appendTo:function(){var t=this.options.appendTo;return t=!(t=!(t=t&&(t.jquery||t.nodeType?x(t):this.document.find(t).eq(0)))||!t[0]?this.element.closest(".ui-front, dialog"):t).length?this.document[0].body:t},_initSource:function(){var i,s,n=this;Array.isArray(this.options.source)?(i=this.options.source,this.source=function(t,e){e(x.ui.autocomplete.filter(i,t.term))}):"string"==typeof this.options.source?(s=this.options.source,this.source=function(t,e){n.xhr&&n.xhr.abort(),n.xhr=x.ajax({url:s,data:t,dataType:"json",success:function(t){e(t)},error:function(){e([])}})}):this.source=this.options.source},_searchTimeout:function(s){clearTimeout(this.searching),this.searching=this._delay(function(){var t=this.term===this._value(),e=this.menu.element.is(":visible"),i=s.altKey||s.ctrlKey||s.metaKey||s.shiftKey;t&&(e||i)||(this.selectedItem=null,this.search(null,s))},this.options.delay)},search:function(t,e){return t=null!=t?t:this._value(),this.term=this._value(),t.length").append(x("
    ").text(e.label)).appendTo(t)},_move:function(t,e){if(this.menu.element.is(":visible"))return this.menu.isFirstItem()&&/^previous/.test(t)||this.menu.isLastItem()&&/^next/.test(t)?(this.isMultiLine||this._value(this.term),void this.menu.blur()):void this.menu[t](e);this.search(null,e)},widget:function(){return this.menu.element},_value:function(){return this.valueMethod.apply(this.element,arguments)},_keyEvent:function(t,e){this.isMultiLine&&!this.menu.element.is(":visible")||(this._move(t,e),e.preventDefault())},_isContentEditable:function(t){if(!t.length)return!1;var e=t.prop("contentEditable");return"inherit"===e?this._isContentEditable(t.parent()):"true"===e}}),x.extend(x.ui.autocomplete,{escapeRegex:function(t){return t.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g,"\\$&")},filter:function(t,e){var i=new RegExp(x.ui.autocomplete.escapeRegex(e),"i");return x.grep(t,function(t){return i.test(t.label||t.value||t)})}}),x.widget("ui.autocomplete",x.ui.autocomplete,{options:{messages:{noResults:"No search results.",results:function(t){return t+(1").text(e))},100))}});x.ui.autocomplete}); \ No newline at end of file diff --git a/docs/script.js b/docs/script.js new file mode 100644 index 0000000..8b9691a --- /dev/null +++ b/docs/script.js @@ -0,0 +1,253 @@ +/* + * Copyright (c) 2013, 2023, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; + +var oddRowColor = "odd-row-color"; +var evenRowColor = "even-row-color"; +var sortAsc = "sort-asc"; +var sortDesc = "sort-desc"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; + +function loadScripts(doc, tag) { + createElem(doc, tag, 'search.js'); + + createElem(doc, tag, 'module-search-index.js'); + createElem(doc, tag, 'package-search-index.js'); + createElem(doc, tag, 'type-search-index.js'); + createElem(doc, tag, 'member-search-index.js'); + createElem(doc, tag, 'tag-search-index.js'); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +// Helper for making content containing release names comparable lexicographically +function makeComparable(s) { + return s.toLowerCase().replace(/(\d+)/g, + function(n, m) { + return ("000" + m).slice(-4); + }); +} + +// Switches between two styles depending on a condition +function toggleStyle(classList, condition, trueStyle, falseStyle) { + if (condition) { + classList.remove(falseStyle); + classList.add(trueStyle); + } else { + classList.remove(trueStyle); + classList.add(falseStyle); + } +} + +// Sorts the rows in a table lexicographically by the content of a specific column +function sortTable(header, columnIndex, columns) { + var container = header.parentElement; + var descending = header.classList.contains(sortAsc); + container.querySelectorAll("div.table-header").forEach( + function(header) { + header.classList.remove(sortAsc); + header.classList.remove(sortDesc); + } + ) + var cells = container.children; + var rows = []; + for (var i = columns; i < cells.length; i += columns) { + rows.push(Array.prototype.slice.call(cells, i, i + columns)); + } + var comparator = function(a, b) { + var ka = makeComparable(a[columnIndex].textContent); + var kb = makeComparable(b[columnIndex].textContent); + if (ka < kb) + return descending ? 1 : -1; + if (ka > kb) + return descending ? -1 : 1; + return 0; + }; + var sorted = rows.sort(comparator); + var visible = 0; + sorted.forEach(function(row) { + if (row[0].style.display !== 'none') { + var isEvenRow = visible++ % 2 === 0; + } + row.forEach(function(cell) { + toggleStyle(cell.classList, isEvenRow, evenRowColor, oddRowColor); + container.appendChild(cell); + }) + }); + toggleStyle(header.classList, descending, sortDesc, sortAsc); +} + +// Toggles the visibility of a table category in all tables in a page +function toggleGlobal(checkbox, selected, columns) { + var display = checkbox.checked ? '' : 'none'; + document.querySelectorAll("div.table-tabs").forEach(function(t) { + var id = t.parentElement.getAttribute("id"); + var selectedClass = id + "-tab" + selected; + // if selected is empty string it selects all uncategorized entries + var selectUncategorized = !Boolean(selected); + var visible = 0; + document.querySelectorAll('div.' + id) + .forEach(function(elem) { + if (selectUncategorized) { + if (elem.className.indexOf(selectedClass) === -1) { + elem.style.display = display; + } + } else if (elem.classList.contains(selectedClass)) { + elem.style.display = display; + } + if (elem.style.display === '') { + var isEvenRow = visible++ % (columns * 2) < columns; + toggleStyle(elem.classList, isEvenRow, evenRowColor, oddRowColor); + } + }); + var displaySection = visible === 0 ? 'none' : ''; + t.parentElement.style.display = displaySection; + document.querySelector("li#contents-" + id).style.display = displaySection; + }) +} + +// Shows the elements of a table belonging to a specific category +function show(tableId, selected, columns) { + if (tableId !== selected) { + document.querySelectorAll('div.' + tableId + ':not(.' + selected + ')') + .forEach(function(elem) { + elem.style.display = 'none'; + }); + } + document.querySelectorAll('div.' + selected) + .forEach(function(elem, index) { + elem.style.display = ''; + var isEvenRow = index % (columns * 2) < columns; + toggleStyle(elem.classList, isEvenRow, evenRowColor, oddRowColor); + }); + updateTabs(tableId, selected); +} + +function updateTabs(tableId, selected) { + document.querySelector('div#' + tableId +' .summary-table') + .setAttribute('aria-labelledby', selected); + document.querySelectorAll('button[id^="' + tableId + '"]') + .forEach(function(tab, index) { + if (selected === tab.id || (tableId === selected && index === 0)) { + tab.className = activeTableTab; + tab.setAttribute('aria-selected', true); + tab.setAttribute('tabindex',0); + } else { + tab.className = tableTab; + tab.setAttribute('aria-selected', false); + tab.setAttribute('tabindex',-1); + } + }); +} + +function switchTab(e) { + var selected = document.querySelector('[aria-selected=true]'); + if (selected) { + if ((e.keyCode === 37 || e.keyCode === 38) && selected.previousSibling) { + // left or up arrow key pressed: move focus to previous tab + selected.previousSibling.click(); + selected.previousSibling.focus(); + e.preventDefault(); + } else if ((e.keyCode === 39 || e.keyCode === 40) && selected.nextSibling) { + // right or down arrow key pressed: move focus to next tab + selected.nextSibling.click(); + selected.nextSibling.focus(); + e.preventDefault(); + } + } +} + +var updateSearchResults = function() {}; + +function indexFilesLoaded() { + return moduleSearchIndex + && packageSearchIndex + && typeSearchIndex + && memberSearchIndex + && tagSearchIndex; +} +// Copy the contents of the local snippet to the clipboard +function copySnippet(button) { + copyToClipboard(button.nextElementSibling.innerText); + switchCopyLabel(button, button.firstElementChild); +} +function copyToClipboard(content) { + var textarea = document.createElement("textarea"); + textarea.style.height = 0; + document.body.appendChild(textarea); + textarea.value = content; + textarea.select(); + document.execCommand("copy"); + document.body.removeChild(textarea); +} +function switchCopyLabel(button, span) { + var copied = span.getAttribute("data-copied"); + button.classList.add("visible"); + var initialLabel = span.innerHTML; + span.innerHTML = copied; + setTimeout(function() { + button.classList.remove("visible"); + setTimeout(function() { + if (initialLabel !== copied) { + span.innerHTML = initialLabel; + } + }, 100); + }, 1900); +} +// Workaround for scroll position not being included in browser history (8249133) +document.addEventListener("DOMContentLoaded", function(e) { + var contentDiv = document.querySelector("div.flex-content"); + window.addEventListener("popstate", function(e) { + if (e.state !== null) { + contentDiv.scrollTop = e.state; + } + }); + window.addEventListener("hashchange", function(e) { + history.replaceState(contentDiv.scrollTop, document.title); + }); + var timeoutId; + contentDiv.addEventListener("scroll", function(e) { + if (timeoutId) { + clearTimeout(timeoutId); + } + timeoutId = setTimeout(function() { + history.replaceState(contentDiv.scrollTop, document.title); + }, 100); + }); + if (!location.hash) { + history.replaceState(contentDiv.scrollTop, document.title); + } +}); diff --git a/docs/search-page.js b/docs/search-page.js new file mode 100644 index 0000000..540c90f --- /dev/null +++ b/docs/search-page.js @@ -0,0 +1,284 @@ +/* + * Copyright (c) 2022, 2023, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +"use strict"; +$(function() { + var copy = $("#page-search-copy"); + var expand = $("#page-search-expand"); + var searchLink = $("span#page-search-link"); + var redirect = $("input#search-redirect"); + function setSearchUrlTemplate() { + var href = document.location.href.split(/[#?]/)[0]; + href += "?q=" + "%s"; + if (redirect.is(":checked")) { + href += "&r=1"; + } + searchLink.html(href); + copy[0].onmouseenter(); + } + function copyLink(e) { + copyToClipboard(this.previousSibling.innerText); + switchCopyLabel(this, this.lastElementChild); + } + copy.click(copyLink); + copy[0].onmouseenter = function() {}; + redirect.click(setSearchUrlTemplate); + setSearchUrlTemplate(); + copy.prop("disabled", false); + redirect.prop("disabled", false); + expand.click(function (e) { + var searchInfo = $("div.page-search-info"); + if(this.parentElement.hasAttribute("open")) { + searchInfo.attr("style", "border-width: 0;"); + } else { + searchInfo.attr("style", "border-width: 1px;").height(searchInfo.prop("scrollHeight")); + } + }); +}); +$(window).on("load", function() { + var input = $("#page-search-input"); + var reset = $("#page-search-reset"); + var notify = $("#page-search-notify"); + var resultSection = $("div#result-section"); + var resultContainer = $("div#result-container"); + var searchTerm = ""; + var activeTab = ""; + var fixedTab = false; + var visibleTabs = []; + var feelingLucky = false; + function renderResults(result) { + if (!result.length) { + notify.html(messages.noResult); + } else if (result.length === 1) { + notify.html(messages.oneResult); + } else { + notify.html(messages.manyResults.replace("{0}", result.length)); + } + resultContainer.empty(); + var r = { + "types": [], + "members": [], + "packages": [], + "modules": [], + "searchTags": [] + }; + for (var i in result) { + var item = result[i]; + var arr = r[item.category]; + arr.push(item); + } + if (!activeTab || r[activeTab].length === 0 || !fixedTab) { + Object.keys(r).reduce(function(prev, curr) { + if (r[curr].length > 0 && r[curr][0].score > prev) { + activeTab = curr; + return r[curr][0].score; + } + return prev; + }, 0); + } + if (feelingLucky && activeTab) { + notify.html(messages.redirecting) + var firstItem = r[activeTab][0]; + window.location = getURL(firstItem.indexItem, firstItem.category); + return; + } + if (result.length > 20) { + if (searchTerm[searchTerm.length - 1] === ".") { + if (activeTab === "types" && r["members"].length > r["types"].length) { + activeTab = "members"; + } else if (activeTab === "packages" && r["types"].length > r["packages"].length) { + activeTab = "types"; + } + } + } + var categoryCount = Object.keys(r).reduce(function(prev, curr) { + return prev + (r[curr].length > 0 ? 1 : 0); + }, 0); + visibleTabs = []; + var tabContainer = $("
    ").appendTo(resultContainer); + for (var key in r) { + var id = "#result-tab-" + key.replace("searchTags", "search_tags"); + if (r[key].length) { + var count = r[key].length >= 1000 ? "999+" : r[key].length; + if (result.length > 20 && categoryCount > 1) { + var button = $("").appendTo(tabContainer); + button.click(key, function(e) { + fixedTab = true; + renderResult(e.data, $(this)); + }); + visibleTabs.push(key); + } else { + $("" + categories[key] + + " (" + count + ")").appendTo(tabContainer); + renderTable(key, r[key]).appendTo(resultContainer); + tabContainer = $("
    ").appendTo(resultContainer); + + } + } + } + if (activeTab && result.length > 20 && categoryCount > 1) { + $("button#result-tab-" + activeTab).addClass("active-table-tab"); + renderTable(activeTab, r[activeTab]).appendTo(resultContainer); + } + resultSection.show(); + function renderResult(category, button) { + activeTab = category; + setSearchUrl(); + resultContainer.find("div.summary-table").remove(); + renderTable(activeTab, r[activeTab]).appendTo(resultContainer); + button.siblings().removeClass("active-table-tab"); + button.addClass("active-table-tab"); + } + } + function selectTab(category) { + $("button#result-tab-" + category).click(); + } + function renderTable(category, items) { + var table = $("
    ") + .addClass(category === "modules" + ? "one-column-search-results" + : "two-column-search-results"); + var col1, col2; + if (category === "modules") { + col1 = "Module"; + } else if (category === "packages") { + col1 = "Module"; + col2 = "Package"; + } else if (category === "types") { + col1 = "Package"; + col2 = "Class" + } else if (category === "members") { + col1 = "Class"; + col2 = "Member"; + } else if (category === "searchTags") { + col1 = "Location"; + col2 = "Name"; + } + $("
    " + col1 + "
    ").appendTo(table); + if (category !== "modules") { + $("
    " + col2 + "
    ").appendTo(table); + } + $.each(items, function(index, item) { + var rowColor = index % 2 ? "odd-row-color" : "even-row-color"; + renderItem(item, table, rowColor); + }); + return table; + } + function renderItem(item, table, rowColor) { + var label = getHighlightedText(item.input, item.boundaries, item.prefix.length, item.input.length); + var link = $("") + .attr("href", getURL(item.indexItem, item.category)) + .attr("tabindex", "0") + .addClass("search-result-link") + .html(label); + var container = getHighlightedText(item.input, item.boundaries, 0, item.prefix.length - 1); + if (item.category === "searchTags") { + container = item.indexItem.h || ""; + } + if (item.category !== "modules") { + $("
    ").html(container).addClass("col-plain").addClass(rowColor).appendTo(table); + } + $("
    ").html(link).addClass("col-last").addClass(rowColor).appendTo(table); + } + var timeout; + function schedulePageSearch() { + if (timeout) { + clearTimeout(timeout); + } + timeout = setTimeout(function () { + doPageSearch() + }, 100); + } + function doPageSearch() { + setSearchUrl(); + var term = searchTerm = input.val().trim(); + if (term === "") { + notify.html(messages.enterTerm); + activeTab = ""; + fixedTab = false; + resultContainer.empty(); + resultSection.hide(); + } else { + notify.html(messages.searching); + doSearch({ term: term, maxResults: 1200 }, renderResults); + } + } + function setSearchUrl() { + var query = input.val().trim(); + var url = document.location.pathname; + if (query) { + url += "?q=" + encodeURI(query); + if (activeTab && fixedTab) { + url += "&c=" + activeTab; + } + } + history.replaceState({query: query}, "", url); + } + input.on("input", function(e) { + feelingLucky = false; + schedulePageSearch(); + }); + $(document).keydown(function(e) { + if ((e.ctrlKey || e.metaKey) && (e.key === "ArrowLeft" || e.key === "ArrowRight")) { + if (activeTab && visibleTabs.length > 1) { + var idx = visibleTabs.indexOf(activeTab); + idx += e.key === "ArrowLeft" ? visibleTabs.length - 1 : 1; + selectTab(visibleTabs[idx % visibleTabs.length]); + return false; + } + } + }); + reset.click(function() { + notify.html(messages.enterTerm); + resultSection.hide(); + activeTab = ""; + fixedTab = false; + resultContainer.empty(); + input.val('').focus(); + setSearchUrl(); + }); + input.prop("disabled", false); + reset.prop("disabled", false); + + var urlParams = new URLSearchParams(window.location.search); + if (urlParams.has("q")) { + input.val(urlParams.get("q")) + } + if (urlParams.has("c")) { + activeTab = urlParams.get("c"); + fixedTab = true; + } + if (urlParams.get("r")) { + feelingLucky = true; + } + if (input.val()) { + doPageSearch(); + } else { + notify.html(messages.enterTerm); + } + input.select().focus(); +}); diff --git a/docs/search.html b/docs/search.html new file mode 100644 index 0000000..7858fb8 --- /dev/null +++ b/docs/search.html @@ -0,0 +1,77 @@ + + + + +Search (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
    + +
    +
    +

    Search

    +
    + + +
    +Additional resources +
    +
    +
    +

    The help page provides an introduction to the scope and syntax of JavaDoc search.

    +

    You can use the <ctrl> or <cmd> keys in combination with the left and right arrow keys to switch between result tabs in this page.

    +

    The URL template below may be used to configure this page as a search engine in browsers that support this feature. It has been tested to work in Google Chrome and Mozilla Firefox. Note that other browsers may not support this feature or require a different URL format.

    +link +

    + +

    +
    +

    Loading search index...

    + +
    +
    +
    + +
    +
    +
    + + diff --git a/docs/search.js b/docs/search.js new file mode 100644 index 0000000..7673397 --- /dev/null +++ b/docs/search.js @@ -0,0 +1,458 @@ +/* + * Copyright (c) 2015, 2023, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ +"use strict"; +const messages = { + enterTerm: "Enter a search term", + noResult: "No results found", + oneResult: "Found one result", + manyResults: "Found {0} results", + loading: "Loading search index...", + searching: "Searching...", + redirecting: "Redirecting to first result...", + linkIcon: "Link icon", + linkToSection: "Link to this section" +} +const categories = { + modules: "Modules", + packages: "Packages", + types: "Types", + members: "Members", + searchTags: "Search Tags" +}; +const highlight = "$&"; +const NO_MATCH = {}; +const MAX_RESULTS = 300; +function checkUnnamed(name, separator) { + return name === "" || !name ? "" : name + separator; +} +function escapeHtml(str) { + return str.replace(//g, ">"); +} +function getHighlightedText(str, boundaries, from, to) { + var start = from; + var text = ""; + for (var i = 0; i < boundaries.length; i += 2) { + var b0 = boundaries[i]; + var b1 = boundaries[i + 1]; + if (b0 >= to || b1 <= from) { + continue; + } + text += escapeHtml(str.slice(start, Math.max(start, b0))); + text += ""; + text += escapeHtml(str.slice(Math.max(start, b0), Math.min(to, b1))); + text += ""; + start = Math.min(to, b1); + } + text += escapeHtml(str.slice(start, to)); + return text; +} +function getURLPrefix(item, category) { + var urlPrefix = ""; + var slash = "/"; + if (category === "modules") { + return item.l + slash; + } else if (category === "packages" && item.m) { + return item.m + slash; + } else if (category === "types" || category === "members") { + if (item.m) { + urlPrefix = item.m + slash; + } else { + $.each(packageSearchIndex, function(index, it) { + if (it.m && item.p === it.l) { + urlPrefix = it.m + slash; + } + }); + } + } + return urlPrefix; +} +function getURL(item, category) { + if (item.url) { + return item.url; + } + var url = getURLPrefix(item, category); + if (category === "modules") { + url += "module-summary.html"; + } else if (category === "packages") { + if (item.u) { + url = item.u; + } else { + url += item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (category === "types") { + if (item.u) { + url = item.u; + } else { + url += checkUnnamed(item.p, "/").replace(/\./g, '/') + item.l + ".html"; + } + } else if (category === "members") { + url += checkUnnamed(item.p, "/").replace(/\./g, '/') + item.c + ".html" + "#"; + if (item.u) { + url += item.u; + } else { + url += item.l; + } + } else if (category === "searchTags") { + url += item.u; + } + item.url = url; + return url; +} +function createMatcher(term, camelCase) { + if (camelCase && !isUpperCase(term)) { + return null; // no need for camel-case matcher for lower case query + } + var pattern = ""; + var upperCase = []; + term.trim().split(/\s+/).forEach(function(w, index, array) { + var tokens = w.split(/(?=[A-Z,.()<>?[\/])/); + for (var i = 0; i < tokens.length; i++) { + var s = tokens[i]; + // ',' and '?' are the only delimiters commonly followed by space in java signatures + pattern += "(" + $.ui.autocomplete.escapeRegex(s).replace(/[,?]/g, "$&\\s*?") + ")"; + upperCase.push(false); + var isWordToken = /\w$/.test(s); + if (isWordToken) { + if (i === tokens.length - 1 && index < array.length - 1) { + // space in query string matches all delimiters + pattern += "(.*?)"; + upperCase.push(isUpperCase(s[0])); + } else { + if (!camelCase && isUpperCase(s) && s.length === 1) { + pattern += "()"; + } else { + pattern += "([a-z0-9$<>?[\\]]*?)"; + } + upperCase.push(isUpperCase(s[0])); + } + } else { + pattern += "()"; + upperCase.push(false); + } + } + }); + var re = new RegExp(pattern, "gi"); + re.upperCase = upperCase; + return re; +} +function findMatch(matcher, input, startOfName, endOfName) { + var from = startOfName; + matcher.lastIndex = from; + var match = matcher.exec(input); + // Expand search area until we get a valid result or reach the beginning of the string + while (!match || match.index + match[0].length < startOfName || endOfName < match.index) { + if (from === 0) { + return NO_MATCH; + } + from = input.lastIndexOf(".", from - 2) + 1; + matcher.lastIndex = from; + match = matcher.exec(input); + } + var boundaries = []; + var matchEnd = match.index + match[0].length; + var score = 5; + var start = match.index; + var prevEnd = -1; + for (var i = 1; i < match.length; i += 2) { + var isUpper = isUpperCase(input[start]); + var isMatcherUpper = matcher.upperCase[i]; + // capturing groups come in pairs, match and non-match + boundaries.push(start, start + match[i].length); + // make sure groups are anchored on a left word boundary + var prevChar = input[start - 1] || ""; + var nextChar = input[start + 1] || ""; + if (start !== 0 && !/[\W_]/.test(prevChar) && !/[\W_]/.test(input[start])) { + if (isUpper && (isLowerCase(prevChar) || isLowerCase(nextChar))) { + score -= 0.1; + } else if (isMatcherUpper && start === prevEnd) { + score -= isUpper ? 0.1 : 1.0; + } else { + return NO_MATCH; + } + } + prevEnd = start + match[i].length; + start += match[i].length + match[i + 1].length; + + // lower score for parts of the name that are missing + if (match[i + 1] && prevEnd < endOfName) { + score -= rateNoise(match[i + 1]); + } + } + // lower score if a type name contains unmatched camel-case parts + if (input[matchEnd - 1] !== "." && endOfName > matchEnd) + score -= rateNoise(input.slice(matchEnd, endOfName)); + score -= rateNoise(input.slice(0, Math.max(startOfName, match.index))); + + if (score <= 0) { + return NO_MATCH; + } + return { + input: input, + score: score, + boundaries: boundaries + }; +} +function isUpperCase(s) { + return s !== s.toLowerCase(); +} +function isLowerCase(s) { + return s !== s.toUpperCase(); +} +function rateNoise(str) { + return (str.match(/([.(])/g) || []).length / 5 + + (str.match(/([A-Z]+)/g) || []).length / 10 + + str.length / 20; +} +function doSearch(request, response) { + var term = request.term.trim(); + var maxResults = request.maxResults || MAX_RESULTS; + if (term.length === 0) { + return this.close(); + } + var matcher = { + plainMatcher: createMatcher(term, false), + camelCaseMatcher: createMatcher(term, true) + } + var indexLoaded = indexFilesLoaded(); + + function getPrefix(item, category) { + switch (category) { + case "packages": + return checkUnnamed(item.m, "/"); + case "types": + return checkUnnamed(item.p, "."); + case "members": + return checkUnnamed(item.p, ".") + item.c + "."; + default: + return ""; + } + } + function useQualifiedName(category) { + switch (category) { + case "packages": + return /[\s/]/.test(term); + case "types": + case "members": + return /[\s.]/.test(term); + default: + return false; + } + } + function searchIndex(indexArray, category) { + var matches = []; + if (!indexArray) { + if (!indexLoaded) { + matches.push({ l: messages.loading, category: category }); + } + return matches; + } + $.each(indexArray, function (i, item) { + var prefix = getPrefix(item, category); + var simpleName = item.l; + var qualifiedName = prefix + simpleName; + var useQualified = useQualifiedName(category); + var input = useQualified ? qualifiedName : simpleName; + var startOfName = useQualified ? prefix.length : 0; + var endOfName = category === "members" && input.indexOf("(", startOfName) > -1 + ? input.indexOf("(", startOfName) : input.length; + var m = findMatch(matcher.plainMatcher, input, startOfName, endOfName); + if (m === NO_MATCH && matcher.camelCaseMatcher) { + m = findMatch(matcher.camelCaseMatcher, input, startOfName, endOfName); + } + if (m !== NO_MATCH) { + m.indexItem = item; + m.prefix = prefix; + m.category = category; + if (!useQualified) { + m.input = qualifiedName; + m.boundaries = m.boundaries.map(function(b) { + return b + prefix.length; + }); + } + matches.push(m); + } + return true; + }); + return matches.sort(function(e1, e2) { + return e2.score - e1.score; + }).slice(0, maxResults); + } + + var result = searchIndex(moduleSearchIndex, "modules") + .concat(searchIndex(packageSearchIndex, "packages")) + .concat(searchIndex(typeSearchIndex, "types")) + .concat(searchIndex(memberSearchIndex, "members")) + .concat(searchIndex(tagSearchIndex, "searchTags")); + + if (!indexLoaded) { + updateSearchResults = function() { + doSearch(request, response); + } + } else { + updateSearchResults = function() {}; + } + response(result); +} +// JQuery search menu implementation +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> .result-item"); + // workaround for search result scrolling + this.menu._scrollIntoView = function _scrollIntoView( item ) { + var borderTop, paddingTop, offset, scroll, elementHeight, itemHeight; + if ( this._hasScroll() ) { + borderTop = parseFloat( $.css( this.activeMenu[ 0 ], "borderTopWidth" ) ) || 0; + paddingTop = parseFloat( $.css( this.activeMenu[ 0 ], "paddingTop" ) ) || 0; + offset = item.offset().top - this.activeMenu.offset().top - borderTop - paddingTop; + scroll = this.activeMenu.scrollTop(); + elementHeight = this.activeMenu.height() - 26; + itemHeight = item.outerHeight(); + + if ( offset < 0 ) { + this.activeMenu.scrollTop( scroll + offset ); + } else if ( offset + itemHeight > elementHeight ) { + this.activeMenu.scrollTop( scroll + offset - elementHeight + itemHeight ); + } + } + }; + }, + _renderMenu: function(ul, items) { + var currentCategory = ""; + var widget = this; + widget.menu.bindings = $(); + $.each(items, function(index, item) { + if (item.category && item.category !== currentCategory) { + ul.append("
  • " + categories[item.category] + "
  • "); + currentCategory = item.category; + } + var li = widget._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", categories[item.category] + " : " + item.l); + } else { + li.attr("aria-label", item.l); + } + li.attr("class", "result-item"); + }); + ul.append(""); + }, + _renderItem: function(ul, item) { + var li = $("
  • ").appendTo(ul); + var div = $("
    ").appendTo(li); + var label = item.l + ? item.l + : getHighlightedText(item.input, item.boundaries, 0, item.input.length); + var idx = item.indexItem; + if (item.category === "searchTags" && idx && idx.h) { + if (idx.d) { + div.html(label + " (" + idx.h + ")
    " + + idx.d + "
    "); + } else { + div.html(label + " (" + idx.h + ")"); + } + } else { + div.html(label); + } + return li; + } +}); +$(function() { + var expanded = false; + var windowWidth; + function collapse() { + if (expanded) { + $("div#navbar-top").removeAttr("style"); + $("button#navbar-toggle-button") + .removeClass("expanded") + .attr("aria-expanded", "false"); + expanded = false; + } + } + $("button#navbar-toggle-button").click(function (e) { + if (expanded) { + collapse(); + } else { + var navbar = $("div#navbar-top"); + navbar.height(navbar.prop("scrollHeight")); + $("button#navbar-toggle-button") + .addClass("expanded") + .attr("aria-expanded", "true"); + expanded = true; + windowWidth = window.innerWidth; + } + }); + $("ul.sub-nav-list-small li a").click(collapse); + $("input#search-input").focus(collapse); + $("main").click(collapse); + $("section[id] > :header, :header[id], :header:has(a[id])").each(function(idx, el) { + // Create anchor links for headers with an associated id attribute + var hdr = $(el); + var id = hdr.attr("id") || hdr.parent("section").attr("id") || hdr.children("a").attr("id"); + if (id) { + hdr.append(" " + messages.linkIcon +""); + } + }); + $(window).on("orientationchange", collapse).on("resize", function(e) { + if (expanded && windowWidth !== window.innerWidth) collapse(); + }); + var search = $("#search-input"); + var reset = $("#reset-button"); + search.catcomplete({ + minLength: 1, + delay: 200, + source: doSearch, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push({ l: messages.noResult }); + } else { + $("#search-input").empty(); + } + }, + autoFocus: true, + focus: function(event, ui) { + return false; + }, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.indexItem) { + var url = getURL(ui.item.indexItem, ui.item.category); + window.location.href = pathtoroot + url; + $("#search-input").focus(); + } + } + }); + search.val(''); + search.prop("disabled", false); + reset.prop("disabled", false); + reset.click(function() { + search.val('').focus(); + }); + search.focus(); +}); diff --git a/docs/serialized-form.html b/docs/serialized-form.html new file mode 100644 index 0000000..1ff34ec --- /dev/null +++ b/docs/serialized-form.html @@ -0,0 +1,143 @@ + + + + +Serialized Form (pmqueue 1.0-SNAPSHOT API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Serialized Form

    +
    +
      +
    • +
      +

      Package io.github.elimelt.pmqueue.message

      +
        +
      • +
        +

        Class io.github.elimelt.pmqueue.message.Message

        +
        class Message extends Object implements Serializable
        +
        +
        serialVersionUID:
        +
        1L
        +
        +
          +
        • +
          +

          Serialization Methods

          +
            +
          • +
            readObject
            +
            private void readObject(ObjectInputStream in) + throws IOException
            +
            Disabled default deserialization. + Use MessageSerializer instead for proper deserialization.
            +
            +
            Parameters:
            +
            in - the input stream to read from
            +
            Throws:
            +
            IOException - always, to prevent default deserialization
            +
            +
          • +
          • +
            writeObject
            +
            private void writeObject(ObjectOutputStream out) + throws IOException
            +
            Custom serialization implementation for better performance. + Writes the message fields directly to the output stream.
            +
            +
            Parameters:
            +
            out - the output stream to write to
            +
            Throws:
            +
            IOException - if an I/O error occurs
            +
            +
          • +
          +
          +
        • +
        • +
          +

          Serialized Fields

          +
            +
          • +
            data
            +
            byte[] data
            +
            The message data.
            +
          • +
          • +
            length
            +
            int length
            +
            The length of the message data.
            +
          • +
          • +
            messageType
            +
            int messageType
            +
            The message type identifier.
            +
          • +
          • +
            timestamp
            +
            long timestamp
            +
            The timestamp when this message was created.
            +
          • +
          +
          +
        • +
        +
        +
      • +
      +
      +
    • +
    +
    +
    +
    + +
    +
    +
    + + diff --git a/docs/stylesheet.css b/docs/stylesheet.css new file mode 100644 index 0000000..f71489f --- /dev/null +++ b/docs/stylesheet.css @@ -0,0 +1,1272 @@ +/* + * Javadoc style sheet + */ + +@import url('resources/fonts/dejavu.css'); + +/* + * These CSS custom properties (variables) define the core color and font + * properties used in this stylesheet. + */ +:root { + /* body, block and code fonts */ + --body-font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; + --block-font-family: 'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + --code-font-family: 'DejaVu Sans Mono', monospace; + /* Base font sizes for body and code elements */ + --body-font-size: 14px; + --code-font-size: 14px; + /* Text colors for body and block elements */ + --body-text-color: #353833; + --block-text-color: #474747; + /* Background colors for various structural elements */ + --body-background-color: #ffffff; + --section-background-color: #f8f8f8; + --detail-background-color: #ffffff; + /* Colors for navigation bar and table captions */ + --navbar-background-color: #4D7A97; + --navbar-text-color: #ffffff; + /* Background color for subnavigation and various headers */ + --subnav-background-color: #dee3e9; + /* Background and text colors for selected tabs and navigation items */ + --selected-background-color: #f8981d; + --selected-text-color: #253441; + --selected-link-color: #1f389c; + /* Background colors for generated tables */ + --even-row-color: #ffffff; + --odd-row-color: #eeeeef; + /* Text color for page title */ + --title-color: #2c4557; + /* Text colors for links */ + --link-color: #4A6782; + --link-color-active: #bb7a2a; + /* Snippet colors */ + --snippet-background-color: #ebecee; + --snippet-text-color: var(--block-text-color); + --snippet-highlight-color: #f7c590; + /* Border colors for structural elements and user defined tables */ + --border-color: #ededed; + --table-border-color: #000000; + /* Search input colors */ + --search-input-background-color: #ffffff; + --search-input-text-color: #000000; + --search-input-placeholder-color: #909090; + /* Highlight color for active search tag target */ + --search-tag-highlight-color: #ffff00; + /* Adjustments for icon and active background colors of copy-to-clipboard buttons */ + --copy-icon-brightness: 100%; + --copy-button-background-color-active: rgba(168, 168, 176, 0.3); + /* Colors for invalid tag notifications */ + --invalid-tag-background-color: #ffe6e6; + --invalid-tag-text-color: #000000; +} +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ +body { + background-color:var(--body-background-color); + color:var(--body-text-color); + font-family:var(--body-font-family); + font-size:var(--body-font-size); + margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; +} +a:link, a:visited { + text-decoration:none; + color:var(--link-color); +} +a[href]:hover, a[href]:focus { + text-decoration:none; + color:var(--link-color-active); +} +pre { + font-family:var(--code-font-family); + font-size:1em; +} +h1 { + font-size:1.428em; +} +h2 { + font-size:1.285em; +} +h3 { + font-size:1.14em; +} +h4 { + font-size:1.072em; +} +h5 { + font-size:1.001em; +} +h6 { + font-size:0.93em; +} +/* Disable font boosting for selected elements */ +h1, h2, h3, h4, h5, h6, div.member-signature { + max-height: 1000em; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:var(--code-font-family); +} +:not(h1, h2, h3, h4, h5, h6) > code, +:not(h1, h2, h3, h4, h5, h6) > tt { + font-size:var(--code-font-size); + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:var(--code-font-family); + font-size:1em; + padding-top:4px; +} +.summary-table dt code { + font-family:var(--code-font-family); + font-size:1em; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +button { + font-family: var(--body-font-family); + font-size: 1em; +} +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + +/* + * Styles for document title and copyright. + */ +.about-language { + float:right; + padding:0 21px 8px 8px; + font-size:0.915em; + margin-top:-9px; + height:2.9em; +} +.legal-copy { + margin-left:.5em; +} +/* + * Styles for navigation bar. + */ +@media screen { + div.flex-box { + position:fixed; + display:flex; + flex-direction:column; + height: 100%; + width: 100%; + } + header.flex-header { + flex: 0 0 auto; + } + div.flex-content { + flex: 1 1 auto; + overflow-y: auto; + } +} +.top-nav { + background-color:var(--navbar-background-color); + color:var(--navbar-text-color); + float:left; + width:100%; + clear:right; + min-height:2.8em; + padding:10px 0 0 0; + overflow:hidden; + font-size:0.857em; +} +button#navbar-toggle-button { + display:none; +} +ul.sub-nav-list-small { + display: none; +} +.sub-nav { + background-color:var(--subnav-background-color); + float:left; + width:100%; + overflow:hidden; + font-size:0.857em; +} +.sub-nav div { + clear:left; + float:left; + padding:6px; + text-transform:uppercase; +} +.sub-nav .sub-nav-list { + padding-top:4px; +} +ul.nav-list { + display:block; + margin:0 25px 0 0; + padding:0; +} +ul.sub-nav-list { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.nav-list li { + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +.sub-nav .nav-list-search { + float:right; + margin:0; + padding:6px; + clear:none; + text-align:right; + position:relative; +} +ul.sub-nav-list li { + list-style:none; + float:left; +} +.top-nav a:link, .top-nav a:active, .top-nav a:visited { + color:var(--navbar-text-color); + text-decoration:none; + text-transform:uppercase; +} +.top-nav a:hover { + color:var(--link-color-active); +} +.nav-bar-cell1-rev { + background-color:var(--selected-background-color); + color:var(--selected-text-color); + margin: auto 5px; +} +.skip-nav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* + * Hide navigation links and search box in print layout + */ +@media print { + ul.nav-list, div.sub-nav { + display:none; + } +} +/* + * Styles for page header. + */ +.title { + color:var(--title-color); + margin:10px 0; +} +.sub-title { + margin:5px 0 0 0; +} +ul.contents-list { + margin: 0 0 15px 0; + padding: 0; + list-style: none; +} +ul.contents-list li { + font-size:0.93em; +} +/* + * Styles for headings. + */ +body.class-declaration-page .summary h2, +body.class-declaration-page .details h2, +body.class-use-page h2, +body.module-declaration-page .block-list h2 { + font-style: italic; + padding:0; + margin:15px 0; +} +body.class-declaration-page .summary h3, +body.class-declaration-page .details h3, +body.class-declaration-page .summary .inherited-list h2 { + background-color:var(--subnav-background-color); + border:1px solid var(--border-color); + margin:0 0 6px -8px; + padding:7px 5px; +} +/* + * Styles for page layout containers. + */ +main { + clear:both; + padding:10px 20px; + position:relative; +} +dl.notes > dt { + font-family: var(--body-font-family); + font-size:0.856em; + font-weight:bold; + margin:10px 0 0 0; + color:var(--body-text-color); +} +dl.notes > dd { + margin:5px 10px 10px 0; + font-size:1em; + font-family:var(--block-font-family) +} +dl.name-value > dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +dl.name-value > dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* + * Styles for lists. + */ +li.circle { + list-style:circle; +} +ul.horizontal li { + display:inline; + font-size:0.9em; +} +div.inheritance { + margin:0; + padding:0; +} +div.inheritance div.inheritance { + margin-left:2em; +} +ul.block-list, +ul.details-list, +ul.member-list, +ul.summary-list { + margin:10px 0 10px 0; + padding:0; +} +ul.block-list > li, +ul.details-list > li, +ul.member-list > li, +ul.summary-list > li { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.ref-list { + padding:0; + margin:0; +} +ul.ref-list > li { + list-style:none; +} +.summary-table dl, .summary-table dl dt, .summary-table dl dd { + margin-top:0; + margin-bottom:1px; +} +ul.tag-list, ul.tag-list-long { + padding-left: 0; + list-style: none; +} +ul.tag-list li { + display: inline; +} +ul.tag-list li:not(:last-child):after, +ul.tag-list-long li:not(:last-child):after +{ + content: ", "; + white-space: pre-wrap; +} +ul.preview-feature-list { + list-style: none; + margin:0; + padding:0.1em; + line-height: 1.6em; +} +/* + * Styles for tables. + */ +.summary-table, .details-table { + width:100%; + border-spacing:0; + border:1px solid var(--border-color); + border-top:0; + padding:0; +} +.caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:var(--selected-text-color); + clear:none; + overflow:hidden; + padding: 10px 0 0 1px; + margin:0; +} +.caption a:link, .caption a:visited { + color:var(--selected-link-color); +} +.caption a:hover, +.caption a:active { + color:var(--navbar-text-color); +} +.caption span { + font-weight:bold; + white-space:nowrap; + padding:5px 12px 7px 12px; + display:inline-block; + float:left; + background-color:var(--selected-background-color); + border: none; + height:16px; +} +div.table-tabs { + padding:10px 0 0 1px; + margin:10px 0 0 0; +} +div.table-tabs > button { + border: none; + cursor: pointer; + padding: 5px 12px 7px 12px; + font-weight: bold; + margin-right: 8px; +} +div.table-tabs > .active-table-tab { + background: var(--selected-background-color); + color: var(--selected-text-color); +} +div.table-tabs > button.table-tab { + background: var(--navbar-background-color); + color: var(--navbar-text-color); +} +.two-column-search-results { + display: grid; + grid-template-columns: minmax(400px, max-content) minmax(400px, auto); +} +div.checkboxes { + line-height: 2em; +} +div.checkboxes > span { + margin-left: 10px; +} +div.checkboxes > label { + margin-left: 8px; + white-space: nowrap; +} +div.checkboxes > label > input { + margin: 0 2px; +} +.two-column-summary { + display: grid; + grid-template-columns: minmax(25%, max-content) minmax(25%, auto); +} +.three-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(20%, max-content) minmax(20%, auto); +} +.three-column-release-summary { + display: grid; + grid-template-columns: minmax(40%, max-content) minmax(10%, max-content) minmax(40%, auto); +} +.four-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(15%, max-content) minmax(15%, max-content) minmax(15%, auto); +} +@media screen and (max-width: 1000px) { + .four-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(15%, auto); + } +} +@media screen and (max-width: 800px) { + .two-column-search-results { + display: grid; + grid-template-columns: minmax(40%, max-content) minmax(40%, auto); + } + .three-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(25%, auto); + } + .three-column-release-summary { + display: grid; + grid-template-columns: minmax(70%, max-content) minmax(30%, max-content) + } + .three-column-summary .col-last, + .three-column-release-summary .col-last{ + grid-column-end: span 2; + } +} +@media screen and (max-width: 600px) { + .two-column-summary { + display: grid; + grid-template-columns: 1fr; + } +} +.summary-table > div, .details-table > div { + text-align:left; + padding: 8px 3px 3px 7px; + overflow-x: auto; + scrollbar-width: thin; +} +.col-first, .col-second, .col-last, .col-constructor-name, .col-summary-item-name { + vertical-align:top; + padding-right:0; + padding-top:8px; + padding-bottom:3px; +} +.table-header { + background:var(--subnav-background-color); + font-weight: bold; +} +/* Sortable table columns */ +.table-header[onclick] { + cursor: pointer; +} +.table-header[onclick]::after { + content:""; + display:inline-block; + background-image:url('data:image/svg+xml; utf8, \ + \ + '); + background-size:100% 100%; + width:9px; + height:14px; + margin-left:4px; + margin-bottom:-3px; +} +.table-header[onclick].sort-asc::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); + +} +.table-header[onclick].sort-desc::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); +} +.col-first, .col-first { + font-size:0.93em; +} +.col-second, .col-second, .col-last, .col-constructor-name, .col-summary-item-name, .col-last { + font-size:0.93em; +} +.col-first, .col-second, .col-constructor-name { + vertical-align:top; + overflow: auto; +} +.col-last { + white-space:normal; +} +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-constructor-name a:link, .col-constructor-name a:visited, +.col-summary-item-name a:link, .col-summary-item-name a:visited { + font-weight:bold; +} +.even-row-color, .even-row-color .table-header { + background-color:var(--even-row-color); +} +.odd-row-color, .odd-row-color .table-header { + background-color:var(--odd-row-color); +} +/* + * Styles for contents. + */ +div.block { + font-size:var(--body-font-size); + font-family:var(--block-font-family); +} +.col-last div { + padding-top:0; +} +.col-last a { + padding-bottom:3px; +} +.module-signature, +.package-signature, +.type-signature, +.member-signature { + font-family:var(--code-font-family); + font-size:1em; + margin:14px 0; + white-space: pre-wrap; +} +.module-signature, +.package-signature, +.type-signature { + margin-top: 0; +} +.member-signature .type-parameters-long, +.member-signature .parameters, +.member-signature .exceptions { + display: inline-block; + vertical-align: top; + white-space: pre; +} +.member-signature .type-parameters { + white-space: normal; +} +/* + * Styles for formatting effect. + */ +.source-line-no { + /* Color of line numbers in source pages can be set via custom property below */ + color:var(--source-linenumber-color, green); + padding:0 30px 0 0; +} +.block { + display:block; + margin:0 10px 5px 0; + color:var(--block-text-color); +} +.deprecated-label, .description-from-type-label, .implementation-label, .member-name-link, +.module-label-in-package, .module-label-in-type, .package-label-in-type, +.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label { + font-weight:bold; +} +.deprecation-comment, .help-footnote, .preview-comment { + font-style:italic; +} +.deprecation-block { + font-size:1em; + font-family:var(--block-font-family); + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +.preview-block { + font-size:1em; + font-family:var(--block-font-family); + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.deprecation-comment { + font-style:normal; +} +details.invalid-tag, span.invalid-tag { + font-size:1em; + font-family:var(--block-font-family); + color: var(--invalid-tag-text-color); + background: var(--invalid-tag-background-color); + border: thin solid var(--table-border-color); + border-radius:2px; + padding: 2px 4px; + display:inline-block; +} +details summary { + cursor: pointer; +} +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-state-active { + /* Overrides the color of selection used in jQuery UI */ + background: var(--selected-background-color); + border: 1px solid var(--selected-background-color); + color: var(--selected-text-color); +} +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:var(--navbar-background-color); + color:var(--navbar-text-color); +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:auto; + overflow-x:auto; + scrollbar-width: thin; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:1; + background-color: var(--body-background-color); +} +ul.ui-autocomplete li { + float:left; + clear:both; + min-width:100%; +} +ul.ui-autocomplete li.ui-static-link { + position:sticky; + bottom:0; + left:0; + background: var(--subnav-background-color); + padding: 5px 0; + font-family: var(--body-font-family); + font-size: 0.93em; + font-weight: bolder; + z-index: 2; +} +li.ui-static-link a, li.ui-static-link a:visited { + text-decoration:none; + color:var(--link-color); + float:right; + margin-right:20px; +} +.ui-autocomplete .result-item { + font-size: inherit; +} +.ui-autocomplete .result-highlight { + font-weight:bold; +} +#search-input, #page-search-input { + background-image:url('resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + background-color: var(--search-input-background-color); + color: var(--search-input-text-color); + border-color: var(--border-color); + padding-left:20px; + width: 250px; + margin: 0; +} +#search-input { + margin-left: 4px; +} +#reset-button { + background-color: transparent; + background-image:url('resources/x.png'); + background-repeat:no-repeat; + background-size:contain; + border:0; + border-radius:0; + width:12px; + height:12px; + position:absolute; + right:12px; + top:10px; + font-size:0; +} +::placeholder { + color:var(--search-input-placeholder-color); + opacity: 1; +} +.search-tag-desc-result { + font-style:italic; + font-size:11px; +} +.search-tag-holder-result { + font-style:italic; + font-size:12px; +} +.search-tag-result:target { + background-color:var(--search-tag-highlight-color); +} +details.page-search-details { + display: inline-block; +} +div#result-container { + font-size: 1em; +} +div#result-container a.search-result-link { + padding: 0; + margin: 4px 0; + width: 100%; +} +#result-container .result-highlight { + font-weight:bolder; +} +.page-search-info { + background-color: var(--subnav-background-color); + border-radius: 3px; + border: 0 solid var(--border-color); + padding: 0 8px; + overflow: hidden; + height: 0; + transition: all 0.2s ease; +} +div.table-tabs > button.table-tab { + background: var(--navbar-background-color); + color: var(--navbar-text-color); +} +.page-search-header { + padding: 5px 12px 7px 12px; + font-weight: bold; + margin-right: 3px; + background-color:var(--navbar-background-color); + color:var(--navbar-text-color); + display: inline-block; +} +button.page-search-header { + border: none; + cursor: pointer; +} +span#page-search-link { + text-decoration: underline; +} +.module-graph span, .sealed-graph span { + display:none; + position:absolute; +} +.module-graph:hover span, .sealed-graph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.inherited-list { + margin: 10px 0 10px 0; +} +section.class-description { + line-height: 1.4; +} +.summary section[class$="-summary"], .details section[class$="-details"], +.class-uses .detail, .serialized-class-details { + padding: 0 20px 5px 10px; + border: 1px solid var(--border-color); + background-color: var(--section-background-color); +} +.inherited-list, section[class$="-details"] .detail { + padding:0 0 5px 8px; + background-color:var(--detail-background-color); + border:none; +} +.vertical-separator { + padding: 0 5px; +} +ul.help-section-list { + margin: 0; +} +ul.help-subtoc > li { + display: inline-block; + padding-right: 5px; + font-size: smaller; +} +ul.help-subtoc > li::before { + content: "\2022" ; + padding-right:2px; +} +.help-note { + font-style: italic; +} +/* + * Indicator icon for external links. + */ +main a[href*="://"]::after { + content:""; + display:inline-block; + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); + background-size:100% 100%; + width:7px; + height:7px; + margin-left:2px; + margin-bottom:4px; +} +main a[href*="://"]:hover::after, +main a[href*="://"]:focus::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); +} +/* + * Styles for header/section anchor links + */ +a.anchor-link { + opacity: 0; + transition: opacity 0.1s; +} +:hover > a.anchor-link { + opacity: 80%; +} +a.anchor-link:hover, +a.anchor-link:focus-visible, +a.anchor-link.visible { + opacity: 100%; +} +a.anchor-link > img { + width: 0.9em; + height: 0.9em; +} +/* + * Styles for copy-to-clipboard buttons + */ +button.copy { + opacity: 70%; + border: none; + border-radius: 3px; + position: relative; + background:none; + transition: opacity 0.3s; + cursor: pointer; +} +:hover > button.copy { + opacity: 80%; +} +button.copy:hover, +button.copy:active, +button.copy:focus-visible, +button.copy.visible { + opacity: 100%; +} +button.copy img { + position: relative; + background: none; + filter: brightness(var(--copy-icon-brightness)); +} +button.copy:active { + background-color: var(--copy-button-background-color-active); +} +button.copy span { + color: var(--body-text-color); + position: relative; + top: -0.1em; + transition: all 0.1s; + font-size: 0.76rem; + line-height: 1.2em; + opacity: 0; +} +button.copy:hover span, +button.copy:focus-visible span, +button.copy.visible span { + opacity: 100%; +} +/* search page copy button */ +button#page-search-copy { + margin-left: 0.4em; + padding:0.3em; + top:0.13em; +} +button#page-search-copy img { + width: 1.2em; + height: 1.2em; + padding: 0.01em 0; + top: 0.15em; +} +button#page-search-copy span { + color: var(--body-text-color); + line-height: 1.2em; + padding: 0.2em; + top: -0.18em; +} +div.page-search-info:hover button#page-search-copy span { + opacity: 100%; +} +/* snippet copy button */ +button.snippet-copy { + position: absolute; + top: 6px; + right: 6px; + height: 1.7em; + padding: 2px; +} +button.snippet-copy img { + width: 18px; + height: 18px; + padding: 0.05em 0; +} +button.snippet-copy span { + line-height: 1.2em; + padding: 0.2em; + position: relative; + top: -0.5em; +} +div.snippet-container:hover button.snippet-copy span { + opacity: 100%; +} +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid var(--table-border-color); +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid var(--table-border-color); +} +table.striped { + border-collapse: collapse; + border: 1px solid var(--table-border-color); +} +table.striped > thead { + background-color: var(--subnav-background-color); +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid var(--table-border-color); +} +table.striped > tbody > tr:nth-child(even) { + background-color: var(--odd-row-color) +} +table.striped > tbody > tr:nth-child(odd) { + background-color: var(--even-row-color) +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid var(--table-border-color); + border-right: 1px solid var(--table-border-color); +} +table.striped > tbody > tr > th { + font-weight: normal; +} +/** + * Tweak style for small screens. + */ +@media screen and (max-width: 920px) { + header.flex-header { + max-height: 100vh; + overflow-y: auto; + } + div#navbar-top { + height: 2.8em; + transition: height 0.35s ease; + } + ul.nav-list { + display: block; + width: 40%; + float:left; + clear: left; + margin: 10px 0 0 0; + padding: 0; + } + ul.nav-list li { + float: none; + padding: 6px; + margin-left: 10px; + margin-top: 2px; + } + ul.sub-nav-list-small { + display:block; + height: 100%; + width: 50%; + float: right; + clear: right; + background-color: var(--subnav-background-color); + color: var(--body-text-color); + margin: 6px 0 0 0; + padding: 0; + } + ul.sub-nav-list-small ul { + padding-left: 20px; + } + ul.sub-nav-list-small a:link, ul.sub-nav-list-small a:visited { + color:var(--link-color); + } + ul.sub-nav-list-small a:hover { + color:var(--link-color-active); + } + ul.sub-nav-list-small li { + list-style:none; + float:none; + padding: 6px; + margin-top: 1px; + text-transform:uppercase; + } + ul.sub-nav-list-small > li { + margin-left: 10px; + } + ul.sub-nav-list-small li p { + margin: 5px 0; + } + div#navbar-sub-list { + display: none; + } + .top-nav a:link, .top-nav a:active, .top-nav a:visited { + display: block; + } + button#navbar-toggle-button { + width: 3.4em; + height: 2.8em; + background-color: transparent; + display: block; + float: left; + border: 0; + margin: 0 10px; + cursor: pointer; + font-size: 10px; + } + button#navbar-toggle-button .nav-bar-toggle-icon { + display: block; + width: 24px; + height: 3px; + margin: 1px 0 4px 0; + border-radius: 2px; + transition: all 0.1s; + background-color: var(--navbar-text-color); + } + button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(1) { + transform: rotate(45deg); + transform-origin: 10% 10%; + width: 26px; + } + button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(2) { + opacity: 0; + } + button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(3) { + transform: rotate(-45deg); + transform-origin: 10% 90%; + width: 26px; + } +} +@media screen and (max-width: 800px) { + .about-language { + padding-right: 16px; + } + ul.nav-list li { + margin-left: 5px; + } + ul.sub-nav-list-small > li { + margin-left: 5px; + } + main { + padding: 10px; + } + .summary section[class$="-summary"], .details section[class$="-details"], + .class-uses .detail, .serialized-class-details { + padding: 0 8px 5px 8px; + } + body { + -webkit-text-size-adjust: none; + } +} +@media screen and (max-width: 400px) { + .about-language { + font-size: 10px; + padding-right: 12px; + } +} +@media screen and (max-width: 400px) { + .nav-list-search { + width: 94%; + } + #search-input, #page-search-input { + width: 70%; + } +} +@media screen and (max-width: 320px) { + .nav-list-search > label { + display: none; + } + .nav-list-search { + width: 90%; + } + #search-input, #page-search-input { + width: 80%; + } +} + +pre.snippet { + background-color: var(--snippet-background-color); + color: var(--snippet-text-color); + padding: 10px; + margin: 12px 0; + overflow: auto; + white-space: pre; +} +div.snippet-container { + position: relative; +} +@media screen and (max-width: 800px) { + pre.snippet { + padding-top: 26px; + } + button.snippet-copy { + top: 4px; + right: 4px; + } +} +pre.snippet .italic { + font-style: italic; +} +pre.snippet .bold { + font-weight: bold; +} +pre.snippet .highlighted { + background-color: var(--snippet-highlight-color); + border-radius: 10%; +} diff --git a/docs/tag-search-index.js b/docs/tag-search-index.js new file mode 100644 index 0000000..bf10aaf --- /dev/null +++ b/docs/tag-search-index.js @@ -0,0 +1 @@ +tagSearchIndex = [{"l":"Constant Field Values","h":"","u":"constant-values.html"},{"l":"Serialized Form","h":"","u":"serialized-form.html"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/type-search-index.js b/docs/type-search-index.js new file mode 100644 index 0000000..1c0bb1e --- /dev/null +++ b/docs/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"io.github.elimelt.pmqueue","l":"QueueConfig.Builder"},{"p":"io.github.elimelt.pmqueue","l":"QueueFactory.CustomQueueBuilder"},{"p":"io.github.elimelt.pmqueue.consumer","l":"DefaultMessageConsumer"},{"p":"io.github.elimelt.pmqueue.producer","l":"DefaultMessageProducer"},{"p":"io.github.elimelt.pmqueue.message","l":"Message"},{"p":"io.github.elimelt.pmqueue.consumer","l":"MessageConsumer"},{"p":"io.github.elimelt.pmqueue.producer","l":"MessageProducer"},{"p":"io.github.elimelt.pmqueue","l":"MessageQueue"},{"p":"io.github.elimelt.pmqueue.message","l":"MessageSerializer"},{"p":"io.github.elimelt.pmqueue.core","l":"PersistentMessageQueue"},{"p":"io.github.elimelt.pmqueue","l":"QueueConfig"},{"p":"io.github.elimelt.pmqueue","l":"QueueFactory"},{"p":"io.github.elimelt.pmqueue","l":"QueueFactory.QueuePreset"}];updateSearchResults(); \ No newline at end of file diff --git a/update_javadoc.sh b/update_javadoc.sh new file mode 100755 index 0000000..a965757 --- /dev/null +++ b/update_javadoc.sh @@ -0,0 +1,33 @@ +mv docs docs_old + +# build javadoc jar +mvn org.apache.maven.plugins:maven-javadoc-plugin:3.5.0:jar + +if [ ! -d docs ]; then + mkdir docs +fi + +cp target/*-javadoc.jar docs/javadoc.jar + + +# go to docs directory +pushd docs + +# unzip javadoc jar +mv javadoc.jar javadoc.jar.zip +unzip -o javadoc.jar.zip -d javadoc + +# remove zip file +rm javadoc.jar.zip + +# copy javadoc to parent directory +cp -r javadoc/* . + +# remove javadoc directory +rm -rf javadoc + +# go back to parent directory +popd + +# remove old docs +rm -rf docs_old \ No newline at end of file