• 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 /**
34  * Interface that generated extensions implement.
35  *
36  * @author liujisi@google.com (Jisi Liu)
37  */
38 public abstract class Extension<ContainingType extends MessageLite, Type>
39     extends ExtensionLite<ContainingType, Type> {
40 
41   /** Returns the descriptor of the extension. */
getDescriptor()42   public abstract Descriptors.FieldDescriptor getDescriptor();
43 
44   /** Returns whether or not this extension is a Lite Extension. */
45   @Override
isLite()46   final boolean isLite() {
47     return false;
48   }
49 
50   // All the methods below are extension implementation details.
51 
52   /**
53    * The API type that the extension is used for.
54    */
55   protected enum ExtensionType {
56     IMMUTABLE,
57     MUTABLE,
58     PROTO1,
59   }
60 
getExtensionType()61   protected ExtensionType getExtensionType() {
62     // TODO(liujisi): make this abstract after we fix proto1.
63     return ExtensionType.IMMUTABLE;
64   }
65 
66   /**
67    * Type of a message extension.
68    */
69   public enum MessageType {
70     PROTO1,
71     PROTO2,
72   }
73 
74   /**
75    * If the extension is a message extension (i.e., getLiteType() == MESSAGE),
76    * returns the type of the message, otherwise undefined.
77    */
getMessageType()78   public MessageType getMessageType() {
79     return MessageType.PROTO2;
80   }
81 
fromReflectionType(Object value)82   protected abstract Object fromReflectionType(Object value);
singularFromReflectionType(Object value)83   protected abstract Object singularFromReflectionType(Object value);
toReflectionType(Object value)84   protected abstract Object toReflectionType(Object value);
singularToReflectionType(Object value)85   protected abstract Object singularToReflectionType(Object value);
86 }
87