MacroFormDetails (Atlassian Confluence 7.12.0-m26 API)

java.lang.Object
- com.atlassian.confluence.macro.browser.beans.MacroFormDetails

```
public class MacroFormDetails
extends Object
```
A Bean that encapsulates the detailed metadata of a macro. This includes the macro parameter information, documentation links and notation help guide contents.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MacroFormDetails.MacroFormDetailsBuilder

Nested Classes
Modifier and Type	Class and Description
`static class`	`MacroFormDetails.MacroFormDetailsBuilder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static MacroFormDetails.MacroFormDetailsBuilder`	`builder()`
`MacroBody`	`getBody()`
`DocumentationLink`	`getDocumentationLink()`
`String`	`getDocumentationUrl()` Deprecated. since 5.5. Use `getDocumentationLink()` instead.
`Set<MacroMigrationPoint>`	`getExcludedSchemaMigrationPoints()`
`String`	`getMacroName()`
`String`	`getNotationHelp()`
`List<MacroParameter>`	`getParameters()`
`int`	`getSchemaVersion()`
`boolean`	`hasRequiredParameters()`
`boolean`	`isFreeform()`
`boolean`	`isShowDefaultParamInPlaceholder()`
`void`	`renderForDisplay(org.apache.velocity.context.Context context)` This method should be called to render macro details before passing to the front end for display.
`void`	`setBody(MacroBody body)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - builder
```
public static MacroFormDetails.MacroFormDetailsBuilder builder()
```
  - getMacroName
```
public String getMacroName()
```
  - renderForDisplay
```
public void renderForDisplay(org.apache.velocity.context.Context context)
```
    This method should be called to render macro details before passing to the front end for display.
    
    Parameters:
    
    context - the velocity context to render with
  - getNotationHelp
```
public String getNotationHelp()
```
    Returns:
    
    the notation help as raw HTML. The renderForDisplay(Context) method must be called before this.
  - getDocumentationUrl
```
@Deprecated
public String getDocumentationUrl()
```
    Deprecated. since 5.5. Use getDocumentationLink() instead.
    
    Returns:
    
    the url to the macro's documentation, if available. Otherwise, null is returned.
  - getDocumentationLink
```
public DocumentationLink getDocumentationLink()
```
    Returns:
    
    the url to the macro's documentation, if available. Otherwise, null is returned.
  - setBody
```
public void setBody(MacroBody body)
```
  - getBody
```
public MacroBody getBody()
```
    Returns:
    
    true if the macro implementation of hasBody() returns true.
    
    See Also:
    
    MacroMetadata.isBodyDeprecated()
  - isFreeform
```
public boolean isFreeform()
```
    Returns:
    
    true if the macro parameter information is not available.
  - isShowDefaultParamInPlaceholder
```
public boolean isShowDefaultParamInPlaceholder()
```
  - getParameters
```
public List<MacroParameter> getParameters()
```
    Returns:
    
    a list of macro paramaters.
  - hasRequiredParameters
```
public boolean hasRequiredParameters()
```
  - getSchemaVersion
```
public int getSchemaVersion()
```
  - getExcludedSchemaMigrationPoints
```
public Set<MacroMigrationPoint> getExcludedSchemaMigrationPoints()
```
    Returns:
    
    points where MacroMigrations should not be run.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class MacroFormDetails

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

getMacroName

renderForDisplay

getNotationHelp

getDocumentationUrl

getDocumentationLink

setBody

getBody

isFreeform

isShowDefaultParamInPlaceholder

getParameters

hasRequiredParameters

getSchemaVersion

getExcludedSchemaMigrationPoints

toString