Package io.github.cdklabs.projen

Class XmlFile

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

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, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.817Z")
@Stability(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	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

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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, addToArray, getOmitEmpty, patch

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

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

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

getProject, isComponent, postSynthesize, preSynthesize

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, 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(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(Experimental)
public XmlFile(@NotNull
               Project project,
               @NotNull
               String filePath)

Parameters:

project - This parameter is required.

filePath - This parameter is required.

Method Detail

synthesizeContent

@Stability(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