View Javadoc

1   /*
2    * ASMember.java
3    * 
4    * Copyright (c) 2006 David Holroyd
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  package uk.co.badgersinfoil.metaas.dom;
20  
21  
22  /**
23   * A member of a type; an {@link ASMethod} or {@link ASField}.
24   */
25  public interface ASMember extends ScriptElement, MetaTagable, Documentable {
26  	/**
27  	 * Returns the name of this field.
28  	 */
29  	public String getName();
30  
31  	/**
32  	 * Changes the name of this ActionScript field to the given value.
33  	 */
34  	public void setName(String string);
35  
36  	/**
37  	 * Returns the name of the return type of value this ActionScript
38  	 * field may contain, or null if it is untyped.
39  	 */
40  	public String getType();
41  
42  	/**
43  	 * Defines the name of the type of object this ActionScript field may
44  	 * contain.  May be set to null, denoting that the value is
45  	 * untyped.
46  	 */
47  	public void setType(String string);
48  
49  	/**
50  	 * Returns a value representing any protection-against-access defined
51  	 * for this ActionScript field.
52  	 */
53  	public Visibility getVisibility();
54  
55  	/**
56  	 * Defines the level of protection-against-external-access for this
57  	 * ActionScript field.
58  	 */
59  	public void setVisibility(Visibility visibility);
60  
61  
62  	/**
63  	 * Returns true if this ActionScript field is static (i.e. the field
64  	 * definition uses the <code>static</code> keyword).
65  	 */
66  	public boolean isStatic();
67  
68  	/**
69  	 * Defines this method to be static, or not.  If set to true, this
70  	 * member definition will be qualified with the <code>static</code>
71  	 * keyword, if false, the keyword will be absent.
72  	 */
73  	public void setStatic(boolean s);
74  }