org.sonar.javascript.model.interfaces.declaration.FunctionDeclarationTree Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javascript-squid Show documentation

The newest version!

/*
 * SonarQube JavaScript Plugin
 * Copyright (C) 2011 SonarSource and Eriks Nukis
 * [email protected]
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package org.sonar.javascript.model.interfaces.declaration;

import org.sonar.javascript.model.interfaces.expression.IdentifierTree;
import org.sonar.javascript.model.interfaces.lexical.SyntaxToken;
import org.sonar.javascript.model.interfaces.statement.BlockTree;
import org.sonar.javascript.model.interfaces.statement.StatementTree;

import javax.annotation.Nullable;

/**
 * Function declaration,
 * Generator function declaration - ES6,
 * 
 *
 * 

 * Function declaration ({@link org.sonar.javascript.model.interfaces.Tree.Kind#FUNCTION_DECLARATION}):
 * 
 *    function {@link #name()} ( {@link #parameters()} ) {@link #body()
 *    }
 * 
 * Generator function declaration ({@link org.sonar.javascript.model.interfaces.Tree.Kind#GENERATOR_DECLARATION}):
 *  *    function * {@link #name()} ( {@link #parameters()} ) {@link #body()
 *    }
 * 
 * 
 */
public interface FunctionDeclarationTree extends StatementTree {

  SyntaxToken functionKeyword();

  @Nullable
  SyntaxToken starToken();

  IdentifierTree name();

  ParameterListTree parameters();

  BlockTree body();

}