UriExportContext Leave feedback
On this page
Inheritance: java.lang.Object
public class UriExportContext
Contains information about a resource URI being written during conversion. Passed to IUriExportStrategy.updateResourceUri(UriExportContext).
Read the default values from resourceFileName and resourceFileUri , then call #setResourceFileName(String).setResourceFileName(String) or #setResourceFileUri(String).setResourceFileUri(String) to override them.
| Constructor | Description |
|---|---|
| UriExportContext(String resourceFileName, String resourceFileUri) |
| Method | Description |
|---|---|
| getResourceFileName() | Gets the default resource file name generated by the library. |
| getResourceFileUri() | Gets the default URI that the library would write into the Markdown output. |
| getResourceFileNameOutput() | Gets the overridden file name, or null if no override was set. |
| getResourceFileUriOutput() | Gets the overridden URI, or null if no override was set. |
| setResourceFileName(String resourceFileName) | Overrides the resource file name in the Markdown output. |
| setResourceFileUri(String resourceFileUri) | Overrides the URI that will appear in the Markdown output. |
public UriExportContext(String resourceFileName, String resourceFileUri)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| resourceFileName | java.lang.String | |
| resourceFileUri | java.lang.String |
public String getResourceFileName()
Gets the default resource file name generated by the library.
Returns: java.lang.String
public String getResourceFileUri()
Gets the default URI that the library would write into the Markdown output.
Returns: java.lang.String
public String getResourceFileNameOutput()
Gets the overridden file name, or null if no override was set.
Returns: java.lang.String
public String getResourceFileUriOutput()
Gets the overridden URI, or null if no override was set.
Returns: java.lang.String
public void setResourceFileName(String resourceFileName)
Overrides the resource file name in the Markdown output.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| resourceFileName | java.lang.String | the new file name |
public void setResourceFileUri(String resourceFileUri)
Overrides the URI that will appear in the Markdown output.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| resourceFileUri | java.lang.String | the new URI (for example, a CDN URL) |
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
