Package org.wurbelizer.wurbel

Class VisualStudioRegion

java.lang.Object

org.wurbelizer.wurbel.AbstractSourceRegion

org.wurbelizer.wurbel.VisualStudioRegion

All Implemented Interfaces:

SourceRegion

public class VisualStudioRegion
extends AbstractSourceRegion

Visual Studio style source region.

Nested Class Summary

Nested classes/interfaces inherited from interface org.wurbelizer.wurbel.SourceRegion

SourceRegion.FoldType

Field Summary

Fields inherited from class org.wurbelizer.wurbel.AbstractSourceRegion

GUARD_BEGIN, GUARD_END

Constructor Summary

Constructors

Constructor	Description
VisualStudioRegion()

Method Summary

Modifier and Type	Method	Description
String	createBegin(SourceRegion.FoldType foldType, String guardName, SourceWurbletSubElement wurbletElement)	Creates the start comment.
String	createEnd(SourceRegion.FoldType foldType, String guardName, SourceWurbletSubElement wurbletElement)	Creates the end comment.
String	getBeginName(String comment)	Gets the region's name (wurblet tag) if this is the start comment is of this region type.
String	getEndName(String comment)	Gets the region's name (wurblet tag) if this is the end comment is of this region type.
boolean	isEnd(String comment, String name)	Returns whether this is the end comment for the given region's name.
String	type()	Gets the unique name of the region type.

Methods inherited from class org.wurbelizer.wurbel.AbstractSourceRegion

createCommentGeneratedBy, matches, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.wurbelizer.wurbel.SourceRegion

isDefault

Constructor Details

VisualStudioRegion

public VisualStudioRegion()

Method Details

type

public String type()

Description copied from interface: SourceRegion

Gets the unique name of the region type.

Returns:

the type name

createBegin

public String createBegin(SourceRegion.FoldType foldType,
 String guardName,
 SourceWurbletSubElement wurbletElement)

Description copied from interface: SourceRegion

Creates the start comment.

Parameters:

foldType - the fold type, null if none

guardName - the name of the guarded section

wurbletElement - the wurblet element

Returns:

the comment

createEnd

public String createEnd(SourceRegion.FoldType foldType,
 String guardName,
 SourceWurbletSubElement wurbletElement)

Description copied from interface: SourceRegion

Creates the end comment.

Parameters:

foldType - the fold type, null if none

guardName - the name of the guarded section

wurbletElement - the wurblet element

Returns:

the comment

getBeginName

public String getBeginName(String comment)

Description copied from interface: SourceRegion

Gets the region's name (wurblet tag) if this is the start comment is of this region type.

Parameters:

comment - the comment string

Returns:

the region's name if is of this type

getEndName

public String getEndName(String comment)

Description copied from interface: SourceRegion

Gets the region's name (wurblet tag) if this is the end comment is of this region type.

Parameters:

comment - the comment string

Returns:

the region's name if is of this type

isEnd

public boolean isEnd(String comment,
 String name)

Description copied from interface: SourceRegion

Returns whether this is the end comment for the given region's name.

Parameters:

comment - the comment string

name - the region's name

Returns:

true if matching end comment