CodeBlock (gmaeni 1.0.0.0 API)

java.lang.Object
- com.emthom.gmaeni.parser.CodeBlock

public class CodeBlock
extends java.lang.Object

Represent a block of JAVA code

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプ	クラスと説明
`static class`	`CodeBlock.BlockType` All JAVA types of code blocks
`static class`	`CodeBlock.Modifier` Modifiers (for class attributes and functions)

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`java.lang.String`	`code` Source code
`int`	`end` Indicate the end position of block in the source code
`boolean`	`hasParent` Indicate if the code block is nested or not.
`boolean`	`injected` Indicate if the code block is injected by programming code.
`int`	`innerOffset` Inner offset (from start of parent)
`CodeBlock.Modifier`	`modifier` define modifier type (public, private, protected)
`java.lang.String`	`name` Black name for Class or function or Annotation
`int`	`offset` Start/End offset (from start of file)
`CodeBlock.BlockType`	`parentType` Type of the parent block
`java.lang.String`	`returnType` Type name of the object returned by the function (optional)
`int`	`start` Indicate the star position of block in the source code
`SmartArrayList<CodeBlock>`	`subBlocks` Sub blocks of code contains by the current block
`SmartArrayList<CodePosition>`	`subIndexes` Sub block position indexes
`CodeBlock.BlockType`	`type` Define type of block
`java.util.ArrayList<CodeString>`	`words` Source code of the block split in words (useful for processing)

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

CodeBlock()

コンストラクタ
コンストラクタと説明
`CodeBlock()`

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`int`	`getEnd()` Return the end position (character index) with offset
`int`	`getStart()` Return the start position (character index) with offset
`boolean`	`hasChildren()` Indicate if the block has children or not
`static boolean`	`isClass(CodeBlock.BlockType blockType)` Indicate if the block is a Class or Anonymous Inner Class
`boolean`	`isComment()` Indicate if the block is a line or block of comment
`static boolean`	`isComment(CodeBlock.BlockType blockType)` Indicate if the block is a line or block of comment
`boolean`	`isFunctionOrClass(CodeBlock.BlockType blockType)` Indicate if the block is a Function or a Class
`java.lang.String`	`toCode()` Generate the source code of the block
`java.lang.String`	`toString()` Return a String version of the object
`void`	`updatePosition(CodeBlock previousBlock)` Update the offset and position of the block from the previous block of the list.
`java.lang.String`	`wordsToString()` Convert all words to a String value (source code)

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- フィールドの詳細
  - start
```
public int start
```
    Indicate the star position of block in the source code
  - end
```
public int end
```
    Indicate the end position of block in the source code
  - offset
```
public int offset
```
    Start/End offset (from start of file)
  - innerOffset
```
public int innerOffset
```
    Inner offset (from start of parent)
  - code
```
public java.lang.String code
```
    Source code
  - name
```
public java.lang.String name
```
    Black name for Class or function or Annotation
  - type
```
public CodeBlock.BlockType type
```
    Define type of block
  - modifier
```
public CodeBlock.Modifier modifier
```
    define modifier type (public, private, protected)
  - returnType
```
public java.lang.String returnType
```
    Type name of the object returned by the function (optional)
  - subBlocks
```
public SmartArrayList<CodeBlock> subBlocks
```
    Sub blocks of code contains by the current block
  - words
```
public java.util.ArrayList<CodeString> words
```
    Source code of the block split in words (useful for processing)
  - hasParent
```
public boolean hasParent
```
    Indicate if the code block is nested or not.
  - subIndexes
```
public SmartArrayList<CodePosition> subIndexes
```
    Sub block position indexes
  - parentType
```
public CodeBlock.BlockType parentType
```
    Type of the parent block
  - injected
```
public boolean injected
```
    Indicate if the code block is injected by programming code.
- コンストラクタの詳細
  - CodeBlock
```
public CodeBlock()
```
- メソッドの詳細
  - getStart
```
public int getStart()
```
    Return the start position (character index) with offset
    
    戻り値:
    
    Start position (character index) with offset
  - getEnd
```
public int getEnd()
```
    Return the end position (character index) with offset
    
    戻り値:
    
    End position (character index) with offset
  - wordsToString
```
public java.lang.String wordsToString()
```
    Convert all words to a String value (source code)
    
    戻り値:
    
    Source code generate from words contains by the block
  - updatePosition
```
public void updatePosition(CodeBlock previousBlock)
```
    Update the offset and position of the block from the previous block of the list.
    
    パラメータ:
    
    previousBlock - Previous block of the list
  - isComment
```
public boolean isComment()
```
    Indicate if the block is a line or block of comment
    
    戻り値:
    
    True if the block is a line or block of comment
  - isFunctionOrClass
```
public boolean isFunctionOrClass(CodeBlock.BlockType blockType)
```
    Indicate if the block is a Function or a Class
    
    パラメータ:
    
    blockType - Type of block
    
    戻り値:
    
    True if the block is a Function or a Class
  - isComment
```
public static boolean isComment(CodeBlock.BlockType blockType)
```
    Indicate if the block is a line or block of comment
    
    パラメータ:
    
    blockType - Type of block
    
    戻り値:
    
    True if the block is a line or block of comment
  - isClass
```
public static boolean isClass(CodeBlock.BlockType blockType)
```
    Indicate if the block is a Class or Anonymous Inner Class
    
    パラメータ:
    
    blockType - Type of block
    
    戻り値:
    
    True if the block is a Class or Anonymous Inner Class
  - toString
```
public java.lang.String toString()
```
    Return a String version of the object
    
    オーバーライド:
    
    toString クラス内 java.lang.Object
    
    戻り値:
    
    String which represent the code block
  - hasChildren
```
public boolean hasChildren()
```
    Indicate if the block has children or not
    
    戻り値:
    
    True if the block has children
  - toCode
```
public java.lang.String toCode()
```
    Generate the source code of the block
    
    戻り値:
    
    Source code of the block

クラス CodeBlock

ネストされたクラスのサマリー

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

start

end

offset

innerOffset

code

name

type

modifier

returnType

subBlocks

words

hasParent

subIndexes

parentType

injected

コンストラクタの詳細

CodeBlock

メソッドの詳細

getStart

getEnd

wordsToString

updatePosition

isComment

isFunctionOrClass

isComment

isClass

toString

hasChildren

toCode