compiler/src/main/java/org/apache/royale/compiler/definitions/IGetterDefinition.java

/*
 *
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */

package org.apache.royale.compiler.definitions;

import org.apache.royale.compiler.projects.ICompilerProject;

/**
 * A definition representing a <code>function get</code> declaration.
 * <p>
 * An <code>IGetterDefinition</code is created from an <code>IGetterNode</code>.
 * <p>
 * For example, the declaration
 * <pre>public function get width():Number;</pre>
 * creates a getter definition whose base name is <code>"width"</code>,
 * whose namespace reference is to the <code>public</code> namespace,
 * whose type reference is named <code>"Number"</code>,
 * and whose return type reference is named <code>"Number"</code>.
 * <p>
 * A getter definition is contained within a file scope, a package scope,
 * a class scope, an interface scope, or a function scope;
 * it contains a function scope.
 */
public interface IGetterDefinition extends IAccessorDefinition
{
    ISetterDefinition resolveSetter(ICompilerProject project);
}