• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Protocol Buffers - Google's data interchange format
2 // Copyright 2008 Google Inc.  All rights reserved.
3 // https://developers.google.com/protocol-buffers/
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 //     * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //     * Redistributions in binary form must reproduce the above
12 // copyright notice, this list of conditions and the following disclaimer
13 // in the documentation and/or other materials provided with the
14 // distribution.
15 //     * Neither the name of Google Inc. nor the names of its
16 // contributors may be used to endorse or promote products derived from
17 // this software without specific prior written permission.
18 //
19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 
31 package com.google.protobuf;
32 
33 // TODO(chrisn): Change ContainingType to extend Message
34 /**
35  * Interface that generated extensions implement.
36  *
37  * @author liujisi@google.com (Jisi Liu)
38  */
39 public abstract class Extension<ContainingType extends MessageLite, Type>
40     extends ExtensionLite<ContainingType, Type> {
41   // TODO(chrisn): Add package-private constructor.
42 
43   /** {@inheritDoc} Overridden to return {@link Message} instead of {@link MessageLite}. */
44   @Override
getMessageDefaultInstance()45   public abstract Message getMessageDefaultInstance();
46 
47   /** Returns the descriptor of the extension. */
getDescriptor()48   public abstract Descriptors.FieldDescriptor getDescriptor();
49 
50   /** Returns whether or not this extension is a Lite Extension. */
51   @Override
isLite()52   final boolean isLite() {
53     return false;
54   }
55 
56   // All the methods below are extension implementation details.
57 
58   /** The API type that the extension is used for. */
59   protected enum ExtensionType {
60     IMMUTABLE,
61     MUTABLE,
62     PROTO1,
63   }
64 
getExtensionType()65   protected abstract ExtensionType getExtensionType();
66 
67   /** Type of a message extension. */
68   public enum MessageType {
69     PROTO1,
70     PROTO2,
71   }
72 
73   /**
74    * If the extension is a message extension (i.e., getLiteType() == MESSAGE), returns the type of
75    * the message, otherwise undefined.
76    */
getMessageType()77   public MessageType getMessageType() {
78     return MessageType.PROTO2;
79   }
80 
fromReflectionType(Object value)81   protected abstract Object fromReflectionType(Object value);
82 
singularFromReflectionType(Object value)83   protected abstract Object singularFromReflectionType(Object value);
84 
toReflectionType(Object value)85   protected abstract Object toReflectionType(Object value);
86 
singularToReflectionType(Object value)87   protected abstract Object singularToReflectionType(Object value);
88 }
89