diff options
author | Ashlee Young <ashlee@onosfw.com> | 2015-09-09 22:15:21 -0700 |
---|---|---|
committer | Ashlee Young <ashlee@onosfw.com> | 2015-09-09 22:15:21 -0700 |
commit | 13d05bc8458758ee39cb829098241e89616717ee (patch) | |
tree | 22a4d1ce65f15952f07a3df5af4b462b4697cb3a /framework/src/onos/core/api/src/main/java/org/onosproject/store/service/DistributedQueueBuilder.java | |
parent | 6139282e1e93c2322076de4b91b1c85d0bc4a8b3 (diff) |
ONOS checkin based on commit tag e796610b1f721d02f9b0e213cf6f7790c10ecd60
Change-Id: Ife8810491034fe7becdba75dda20de4267bd15cd
Diffstat (limited to 'framework/src/onos/core/api/src/main/java/org/onosproject/store/service/DistributedQueueBuilder.java')
-rw-r--r-- | framework/src/onos/core/api/src/main/java/org/onosproject/store/service/DistributedQueueBuilder.java | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/store/service/DistributedQueueBuilder.java b/framework/src/onos/core/api/src/main/java/org/onosproject/store/service/DistributedQueueBuilder.java new file mode 100644 index 00000000..646dc28c --- /dev/null +++ b/framework/src/onos/core/api/src/main/java/org/onosproject/store/service/DistributedQueueBuilder.java @@ -0,0 +1,79 @@ +/* + * Copyright 2015 Open Networking Laboratory + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.onosproject.store.service; + +/** + * Builder for distributed queue. + * + * @param <E> type queue elements. + */ +public interface DistributedQueueBuilder<E> { + + /** + * Sets the name of the queue. + * <p> + * Each queue is identified by a unique name. + * </p> + * <p> + * Note: This is a mandatory parameter. + * </p> + * + * @param name name of the queue + * @return this DistributedQueueBuilder for method chaining + */ + DistributedQueueBuilder<E> withName(String name); + + /** + * Sets a serializer that can be used to serialize + * the elements pushed into the queue. The serializer + * builder should be pre-populated with any classes that will be + * put into the queue. + * <p> + * Note: This is a mandatory parameter. + * </p> + * + * @param serializer serializer + * @return this DistributedQueueBuilder for method chaining + */ + DistributedQueueBuilder<E> withSerializer(Serializer serializer); + + /** + * + * + * @return this DistributedQueueBuilder for method chaining + */ + DistributedQueueBuilder<E> withMeteringDisabled(); + + + /** + * Disables persistence of queues entries. + * <p> + * When persistence is disabled, a full cluster restart will wipe out all + * queue entries. + * </p> + * @return this DistributedQueueBuilder for method chaining + */ + DistributedQueueBuilder<E> withPersistenceDisabled(); + + /** + * Builds a queue based on the configuration options + * supplied to this builder. + * + * @return new distributed queue + * @throws java.lang.RuntimeException if a mandatory parameter is missing + */ + DistributedQueue<E> build(); +} |