1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
/* Copyright (C) 2003 Vladimir Roubtsov. All rights reserved.
*
* This program and the accompanying materials are made available under
* the terms of the Common Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/cpl-v10.html
*
* $Id: IMethodCollection.java,v 1.1.1.1 2004/05/09 16:57:46 vlad_r Exp $
*/
package com.vladium.jcd.cls;
import com.vladium.jcd.compiler.IClassFormatOutput;
// ----------------------------------------------------------------------------
/**
* An abstraction of the 'methods' component of .class format. The contents
* are {@link Method_info} structures corresponding to all methods directly
* declared by this class/interface. The order in which they appear is
* unspecified.
*
* @author (C) 2001, Vlad Roubtsov
*/
public
interface IMethodCollection extends Cloneable, IClassFormatOutput
{
// public: ................................................................
// ACCESSORS:
/**
* Returns {@link Method_info} descriptor at a given offset.
*
* @param offset method offset [must be in [0, size()) range; input not checked]
* @return Method_info descriptor [never null]
*
* @throws IndexOutOfBoundsException if 'offset' is outside of valid range
*/
Method_info get (int offset);
/**
* Returns an array of offsets for methods named 'name' (empty array if no
* matching fields found).
*
* @param cls class definition providing the constant pool against which to
* resolve names [may not be null]
* @param name method name [null or empty will result in no matches]
* @return array of method offsets in no particular order [never null; could be empty]
*
* @throws IllegalArgumentException if 'cls' is null
*/
int [] get (ClassDef cls, String name);
/**
* Returns the number of methods in this collection [can be 0].
*/
int size ();
// Cloneable: adjust the access level of Object.clone():
Object clone ();
// Visitor:
void accept (IClassDefVisitor visitor, Object ctx);
// MUTATORS:
/**
* Adds a new Method_info descriptor to this collection. No duplicate
* checks are made. It is the responsibility of the caller to ensure
* that all data referenced in 'method' will eventually appear in the
* constant pool.
*
* @param method new method descriptor [may not be null]
*/
int add (Method_info method);
/**
* Replaces the Method_info descriptor at a given offset. No duplicate
* checks are made. No method type compatibility checks are made. It is
* the responsibility of the caller to ensure that all data referenced
* in 'method' will eventually appear in the constant pool.
*
* @param offset method offset [must be in [0, size()) range; input not checked]
* @param method new method descriptor [may not be null]
* @return previous method descriptor at this offset [never null]
*
* @throws IndexOutOfBoundsException if 'offset' is outside of valid range
*/
Method_info set (int offset, Method_info method);
// TODO: support this via iterators instead
/**
* Removes the Method_info descriptor at a given offset. It is
* the responsibility of the caller to ensure that the class definition
* remains consistent after this change.
*
* @param offset method offset [must be in [0, size()) range; input not checked]
* @return method descriptor at this offset [never null]
*
* @throws IndexOutOfBoundsException if 'offset' is outside of valid range
*/
Method_info remove (int offset);
} // end of interface
// ----------------------------------------------------------------------------
|
