ImmutableMethod.java revision 2d7e1111358e2b8cc951a46dc8b0217a7fa0dead
1e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver/*
2e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * Copyright 2012, Google Inc.
3e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * All rights reserved.
4e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver *
5e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * Redistribution and use in source and binary forms, with or without
6e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * modification, are permitted provided that the following conditions are
7e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * met:
8e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver *
9e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver *     * Redistributions of source code must retain the above copyright
10e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * notice, this list of conditions and the following disclaimer.
11e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver *     * Redistributions in binary form must reproduce the above
12e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * copyright notice, this list of conditions and the following disclaimer
13e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * in the documentation and/or other materials provided with the
14e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * distribution.
15e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver *     * Neither the name of Google Inc. nor the names of its
16e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * contributors may be used to endorse or promote products derived from
17e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * this software without specific prior written permission.
18e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver *
19e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver */
31e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver
32e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruverpackage org.jf.dexlib2.immutable;
33e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver
34e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruverimport com.google.common.collect.ImmutableList;
35f81150ad43efac4d590f6b7ea1425896b7ffb011Ben Gruverimport org.jf.dexlib2.base.reference.BaseMethodReference;
36f4662586da3c902c3a0ed21a174b814e248c7fb8Ben Gruverimport org.jf.dexlib2.iface.Annotation;
37f4662586da3c902c3a0ed21a174b814e248c7fb8Ben Gruverimport org.jf.dexlib2.iface.Method;
38f4662586da3c902c3a0ed21a174b814e248c7fb8Ben Gruverimport org.jf.dexlib2.iface.MethodImplementation;
39f4662586da3c902c3a0ed21a174b814e248c7fb8Ben Gruverimport org.jf.dexlib2.iface.MethodParameter;
40e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruverimport org.jf.util.ImmutableListConverter;
412d7e1111358e2b8cc951a46dc8b0217a7fa0deadBen Gruverimport org.jf.util.ImmutableUtils;
42e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver
43e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruverimport javax.annotation.Nonnull;
44e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruverimport javax.annotation.Nullable;
4512b970ed4dfad768002335503e49c348ea0ed69bBen Gruverimport java.util.Collection;
46e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver
47f81150ad43efac4d590f6b7ea1425896b7ffb011Ben Gruverpublic class ImmutableMethod extends BaseMethodReference implements Method {
48a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver    @Nonnull public final String containingClass;
49e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver    @Nonnull public final String name;
50e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver    @Nonnull public final ImmutableList<? extends ImmutableMethodParameter> parameters;
51e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver    @Nonnull public final String returnType;
52e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver    public final int accessFlags;
53e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver    @Nonnull public final ImmutableList<? extends ImmutableAnnotation> annotations;
54e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver    @Nullable public final ImmutableMethodImplementation methodImplementation;
55e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver
56a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver    public ImmutableMethod(@Nonnull String containingClass,
57a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver                           @Nonnull String name,
5812b970ed4dfad768002335503e49c348ea0ed69bBen Gruver                           @Nullable Collection<? extends MethodParameter> parameters,
59e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                           @Nonnull String returnType,
60e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                           int accessFlags,
61c6e54994a7be1bdbdd751ede7c96e07e7fb1c84fBen Gruver                           @Nullable Collection<? extends Annotation> annotations,
62e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                           @Nullable MethodImplementation methodImplementation) {
63a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver        this.containingClass = containingClass;
64e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver        this.name = name;
65e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver        this.parameters = ImmutableMethodParameter.immutableListOf(parameters);
66e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver        this.returnType = returnType;
67e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver        this.accessFlags = accessFlags;
68e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver        this.annotations = ImmutableAnnotation.immutableListOf(annotations);
69e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver        this.methodImplementation = ImmutableMethodImplementation.of(methodImplementation);
70e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver    }
71e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver
72a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver    public ImmutableMethod(@Nonnull String containingClass,
73a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver                           @Nonnull String name,
74e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                           @Nullable ImmutableList<? extends ImmutableMethodParameter> parameters,
75e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                           @Nonnull String returnType,
76e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                           int accessFlags,
77e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                           @Nullable ImmutableList<? extends ImmutableAnnotation> annotations,
78e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                           @Nullable ImmutableMethodImplementation methodImplementation) {
79a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver        this.containingClass = containingClass;
80e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver        this.name = name;
812d7e1111358e2b8cc951a46dc8b0217a7fa0deadBen Gruver        this.parameters = ImmutableUtils.nullToEmptyList(parameters);
82e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver        this.returnType = returnType;
83e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver        this.accessFlags = accessFlags;
842d7e1111358e2b8cc951a46dc8b0217a7fa0deadBen Gruver        this.annotations = ImmutableUtils.nullToEmptyList(annotations);
85e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver        this.methodImplementation = methodImplementation;
86e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver    }
87e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver
88e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver    public static ImmutableMethod of(Method method) {
89e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver        if (method instanceof ImmutableMethod) {
90e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver            return (ImmutableMethod)method;
91e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver        }
92e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver        return new ImmutableMethod(
93a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver                method.getContainingClass(),
94e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                method.getName(),
95e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                method.getParameters(),
96e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                method.getReturnType(),
97e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                method.getAccessFlags(),
98e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                method.getAnnotations(),
99e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                method.getImplementation());
100e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver    }
101e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver
102a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver    @Nonnull public String getContainingClass() { return containingClass; }
103e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver    @Nonnull public String getName() { return name; }
104e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver    @Nonnull public ImmutableList<? extends ImmutableMethodParameter> getParameters() { return parameters; }
105e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver    @Nonnull public String getReturnType() { return returnType; }
106e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver    public int getAccessFlags() { return accessFlags; }
107e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver    @Nonnull public ImmutableList<? extends ImmutableAnnotation> getAnnotations() { return annotations; }
108e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver    @Nullable public ImmutableMethodImplementation getImplementation() { return methodImplementation; }
109e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver
110e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver    @Nonnull
11112b970ed4dfad768002335503e49c348ea0ed69bBen Gruver    public static ImmutableList<ImmutableMethod> immutableListOf(@Nullable Iterable<? extends Method> list) {
112e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver        return CONVERTER.convert(list);
113e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver    }
114e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver
115e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver    private static final ImmutableListConverter<ImmutableMethod, Method> CONVERTER =
116e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver            new ImmutableListConverter<ImmutableMethod, Method>() {
117e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                @Override
118ddf20219422e40a1e60268d8049093602d7bacf8Ben Gruver                protected boolean isImmutable(@Nonnull Method item) {
119e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                    return item instanceof ImmutableMethod;
120e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                }
121e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver
122ddf20219422e40a1e60268d8049093602d7bacf8Ben Gruver                @Nonnull
123e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                @Override
124ddf20219422e40a1e60268d8049093602d7bacf8Ben Gruver                protected ImmutableMethod makeImmutable(@Nonnull Method item) {
125e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                    return ImmutableMethod.of(item);
126e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver                }
127e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver            };
128e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver}
129