Prepare for 1.1.1 release, with fixed OSGi metadata, inclusion of util classes

Author: cowtowncoder

VERSION.txt

@@ -5,15 +5,13 @@ Licence: Apache 2.0
 Releases
 ======================================================================
 
-1.1.1 (not yet released)
-
-- Add missing OSGi export for "com.fasterxml.util.membuf.util"
-
-1.1.0 (05-Nov-2014)
+1.1.1 (05-Nov-2014)
 
 #21: Add `com.fasterxml.util.membuf.util.BufferRecycler` to help with buffer reuse
 #22: Add convenience class for UTF-8 encoding/decoding, `com.fasterxml.util.membuf.util.UTF8Mate`
 
+(1.1.0 was released, but was broken wrt OSGi metadata -- do not use)
+
 1.0.0 (22-Oct-2013)
 
 The first official release -- library has been used in high-traffic

pom.xml

@@ -61,7 +61,7 @@ garbage collection overhead (especially latency)
     <plugins>
       <plugin>
         <artifactId>maven-compiler-plugin</artifactId>
-        <version>2.3.2</version>
+        <version>3.1</version>
         <configuration>
           <source>1.6</source>
           <target>1.6</target>
@@ -70,7 +70,7 @@ garbage collection overhead (especially latency)
         <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-release-plugin</artifactId>
-            <version>2.1</version>
+            <version>2.4.2</version>
             <configuration>
                 <mavenExecutorId>forked-path</mavenExecutorId>
             </configuration>
@@ -91,7 +91,7 @@ garbage collection overhead (especially latency)
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-javadoc-plugin</artifactId>
-          <version>2.6.1</version>
+          <version>2.8.1</version>
           <configuration>
                     <source>1.6</source>
                     <target>1.6</target>
@@ -116,7 +116,7 @@ garbage collection overhead (especially latency)
         <plugin>
           <groupId>org.apache.felix</groupId>
           <artifactId>maven-bundle-plugin</artifactId>
-          <version>2.3.6</version>
+          <version>2.5.3</version>
           <extensions>true</extensions>
           <configuration>
             <instructions>

src/main/java/com/fasterxml/util/membuf/MemBufferDecorator.java

@@ -2,7 +2,7 @@
 
 /**
  * Interface that defines decorators that may be registered to
- * decorate {@like MemBuffer} instances created.
+ * decorate {@link MemBuffer} instances created.
  * Decoration is typically used to add features such as auto-closing,
  * or logging.
  * 

src/main/java/com/fasterxml/util/membuf/SegmentAllocator.java

@@ -61,7 +61,7 @@ public abstract class SegmentAllocator<T extends Segment<T>>
     /**
      * Constructor for creating simple allocator instances.
      * Basic configuration is used to limit amount of memory that will
-     * be used (by {@link maxSegments}), as well as degree to which
+     * be used (by <code>maxSegments</code>), as well as degree to which
      * allocator can reuse released segments (to reduce churn by freeing
      * and reallocating segments, as segments typically use native
      * {@link java.nio.ByteBuffer}s that may be costly to allocate.

src/main/java/com/fasterxml/util/membuf/base/BytesSegment.java

@@ -1,8 +1,8 @@
 package com.fasterxml.util.membuf.base;
 
 /**
- * Intermediate base class for {@link Segment}s used to store
- * byte sequence values.
+ * Intermediate base class for {@link com.fasterxml.util.membuf.Segment}s
+ * used to store byte sequence values.
  */
 public abstract class BytesSegment extends SegmentBase<BytesSegment>
 {

src/main/java/com/fasterxml/util/membuf/base/LongsSegment.java

@@ -1,7 +1,7 @@
 package com.fasterxml.util.membuf.base;
 
 /**
- * Intermediate base class for {@link Segment}s used to store
+ * Intermediate base class for {@link com.fasterxml.util.membuf.Segment}s used to store
  * long-valued sequences.
  */
 public abstract class LongsSegment extends SegmentBase<LongsSegment>
@@ -26,6 +26,7 @@ public abstract class LongsSegment extends SegmentBase<LongsSegment>
     /**
      * Method for trying to skip up to specified number of bytes.
      */
+    @Override
     public abstract int skip(int length);
 
     /*

src/main/java/com/fasterxml/util/membuf/base/MemBuffersBase.java

@@ -109,6 +109,7 @@ public final CB createChunkyBuffer(int minSegmentsForBuffer, int maxSegmentsForB
      * If construction fails (due to allocation limits),
      * null will be returned.
      */
+    @SuppressWarnings("resource")
     public final CB tryCreateChunkyBuffer(int minSegmentsForBuffer, int maxSegmentsForBuffer)
     {
         S initialSegments = _segmentAllocator.allocateSegments(minSegmentsForBuffer, null);
@@ -151,6 +152,7 @@ public final SB createStreamyBuffer(int minSegmentsForBuffer, int maxSegmentsFor
      * If construction fails (due to allocation limits),
      * null will be returned.
      */
+    @SuppressWarnings("resource")
     public final SB tryCreateStreamyBuffer(int minSegmentsForBuffer, int maxSegmentsForBuffer)
     {
         S initialSegments = _segmentAllocator.allocateSegments(minSegmentsForBuffer, null);

src/main/java/com/fasterxml/util/membuf/base/SegmentAllocatorBase.java

@@ -36,7 +36,7 @@ public abstract class SegmentAllocatorBase<S extends Segment<S>>
     /**
      * Constructor for creating simple allocator instances.
      * Basic configuration is used to limit amount of memory that will
-     * be used (by {@link maxSegments}), as well as degree to which
+     * be used (by <code>maxSegments</code>), as well as degree to which
      * allocator can reuse released segments (to reduce churn by freeing
      * and reallocating segments, as segments typically use native
      * {@link java.nio.ByteBuffer}s that may be costly to allocate.
@@ -77,6 +77,7 @@ public SegmentAllocatorBase(int segmentSize, int minSegmentsToRetain, int maxSeg
      * @return Head of segment list (with newly allocated entries as first
      *    entries) if allocation succeeded; null if not
      */
+    @Override
     public synchronized S allocateSegments(int count, S segmentList)
     {
         if (count < 1) {
@@ -96,6 +97,7 @@ public synchronized S allocateSegments(int count, S segmentList)
      * contents of a segment and do not want to hold on to it for local
      * reuse.
      */
+    @Override
     public synchronized void releaseSegment(S segToRelease)
     {
         if (--_bufferOwnedSegmentCount < 0) { // sanity check; not needed in perfect world

src/main/java/com/fasterxml/util/membuf/base/SegmentBase.java

@@ -40,11 +40,11 @@ public abstract class SegmentBase<S extends Segment<S>>
     /**********************************************************************
      */
 
-    public SegmentBase()
-    {
+    public SegmentBase() {
         _state = State.FREE;        
     }
 
+    @Override
     public final State state() { return _state; }
 
     /*

src/main/java/com/fasterxml/util/membuf/impl/ArrayLongsSegment.java

@@ -27,7 +27,7 @@ public ArrayLongsSegment(int size)
     }
 
     /**
-     * Factory method for construction {@link LongsSegmentAllocator} that
+     * Factory method for constructing an {@link Allocator} that
      * constructs instances of this segment type
      */
     public static Allocator allocator(int segmentSize, int minSegmentsToRetain, int maxSegments) {
@@ -196,7 +196,8 @@ public static class Allocator extends SegmentAllocatorBase<LongsSegment>
         public Allocator(int segmentSize, int minSegmentsToRetain, int maxSegments) {
             super(segmentSize, minSegmentsToRetain, maxSegments);
         }
-        
+
+        @Override
         protected LongsSegment _allocateSegment()
         {
             // can reuse a segment returned earlier?