io.github.cdklabs.projen

Class XmlFile

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.FileBase

io.github.cdklabs.projen.ObjectFile

io.github.cdklabs.projen.XmlFile

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.456Z")
 @Stability(value=Experimental)
public class XmlFile
extends ObjectFile

(experimental) Represents an XML file.

Objects passed in will be synthesized using the npm "xml" library.

See Also:

https://www.npmjs.com/package/xml

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmlFile.Builder (experimental) A fluent builder for XmlFile.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields inherited from class io.github.cdklabs.projen.FileBase

PROJEN_MARKER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XmlFile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	XmlFile(software.amazon.jsii.JsiiObjectRef objRef)
	XmlFile(Project project, String filePath)
	XmlFile(Project project, String filePath, XmlFileOptions options)

Method Summary

Modifier and Type	Method and Description
protected String	synthesizeContent(IResolver resolver) (experimental) Implemented by derived classes and returns the contents of the file to emit.

Methods inherited from class io.github.cdklabs.projen.ObjectFile

addDeletionOverride, addOverride, getMarker, getOmitEmpty, setMarker

Methods inherited from class io.github.cdklabs.projen.FileBase

getAbsolutePath, getExecutable, getPath, getReadonly, setExecutable, setReadonly, synthesize

Methods inherited from class io.github.cdklabs.projen.Component

getProject, postSynthesize, preSynthesize

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

XmlFile

protected XmlFile(software.amazon.jsii.JsiiObjectRef objRef)

XmlFile

protected XmlFile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

XmlFile

@Stability(value=Experimental)
public XmlFile(@NotNull
                                              Project project,
                                              @NotNull
                                              String filePath,
                                              @Nullable
                                              XmlFileOptions options)

Parameters:

project - This parameter is required.

filePath - This parameter is required.

options -

XmlFile

@Stability(value=Experimental)
public XmlFile(@NotNull
                                              Project project,
                                              @NotNull
                                              String filePath)

Parameters:

project - This parameter is required.

filePath - This parameter is required.

Method Detail

synthesizeContent

@Stability(value=Experimental)
 @Nullable
protected String synthesizeContent(@NotNull
                                                                             IResolver resolver)

(experimental) Implemented by derived classes and returns the contents of the file to emit.

Overrides:

synthesizeContent in class ObjectFile

Parameters:

resolver - This parameter is required.

Returns:

the content to synthesize or undefined to skip the file