View Javadoc

1   /*
2    * Copyright 2009 Red Hat, Inc.
3    *
4    * Red Hat licenses this file to you under the Apache License, version 2.0
5    * (the "License"); you may not use this file except in compliance with the
6    * License.  You may obtain a copy of the License at:
7    *
8    *    http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package org.jboss.netty.buffer;
17  
18  import java.nio.ByteOrder;
19  
20  /**
21   * A skeletal implementation of {@link ChannelBufferFactory}.
22   *
23   * @author <a href="http://www.jboss.org/netty/">The Netty Project</a>
24   * @author <a href="http://gleamynode.net/">Trustin Lee</a>
25   *
26   * @version $Rev: 2080 $, $Date: 2010-01-26 18:04:19 +0900 (Tue, 26 Jan 2010) $
27   */
28  public abstract class AbstractChannelBufferFactory implements ChannelBufferFactory {
29  
30      private final ByteOrder defaultOrder;
31  
32      /**
33       * Creates a new factory whose default {@link ByteOrder} is
34       * {@link ByteOrder#BIG_ENDIAN}.
35       */
36      protected AbstractChannelBufferFactory() {
37          this(ByteOrder.BIG_ENDIAN);
38      }
39  
40      /**
41       * Creates a new factory with the specified default {@link ByteOrder}.
42       *
43       * @param defaultOrder the default {@link ByteOrder} of this factory
44       */
45      protected AbstractChannelBufferFactory(ByteOrder defaultOrder) {
46          if (defaultOrder == null) {
47              throw new NullPointerException("defaultOrder");
48          }
49          this.defaultOrder = defaultOrder;
50      }
51  
52      public ChannelBuffer getBuffer(int capacity) {
53          return getBuffer(getDefaultOrder(), capacity);
54      }
55  
56      public ChannelBuffer getBuffer(byte[] array, int offset, int length) {
57          return getBuffer(getDefaultOrder(), array, offset, length);
58      }
59  
60      public ByteOrder getDefaultOrder() {
61          return defaultOrder;
62      }
63  }