Package io.github.cdklabs.projen

Class GitAttributesFile

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.FileBase

io.github.cdklabs.projen.GitAttributesFile

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.753Z")
@Stability(Experimental)
public class GitAttributesFile
extends FileBase

(experimental) Assign attributes to file names in a git repository.

See Also:

https://git-scm.com/docs/gitattributes

Nested Class Summary

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
protected	GitAttributesFile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	GitAttributesFile(software.amazon.jsii.JsiiObjectRef objRef)
	GitAttributesFile(software.constructs.IConstruct scope)

Method Summary

Modifier and Type	Method	Description
void	addAttributes(String glob, @NotNull String... attributes)	(experimental) Maps a set of attributes to a set of files.
void	addLfsPattern(String glob)	(experimental) Add attributes necessary to mark these files as stored in LFS.
Boolean	getHasLfsPatterns()	(experimental) Whether the current gitattributes file has any LFS patterns.
void	preSynthesize()	(experimental) Called before synthesis.
protected String	synthesizeContent(IResolver __)	(experimental) Implemented by derived classes and returns the contents of the file to emit.

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

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

GitAttributesFile

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

GitAttributesFile

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

GitAttributesFile

@Stability(Experimental)
public GitAttributesFile(@NotNull
                         software.constructs.IConstruct scope)

Parameters:

scope - This parameter is required.

Method Detail

addAttributes

@Stability(Experimental)
public void addAttributes(@NotNull
                          String glob,
                          @NotNull
                          @NotNull String... attributes)

(experimental) Maps a set of attributes to a set of files.

Parameters:

glob - Glob pattern to match files in the repo. This parameter is required.

attributes - Attributes to assign to these files. This parameter is required.

addLfsPattern

@Stability(Experimental)
public void addLfsPattern(@NotNull
                          String glob)

(experimental) Add attributes necessary to mark these files as stored in LFS.

Parameters:

glob - This parameter is required.

preSynthesize

@Stability(Experimental)
public void preSynthesize()

(experimental) Called before synthesis.

Overrides:

preSynthesize in class Component

synthesizeContent

@Stability(Experimental)
@Nullable
protected String synthesizeContent(@NotNull
                                   IResolver __)

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

Specified by:

synthesizeContent in class FileBase

Parameters:

_ - This parameter is required.

Returns:

the content to synthesize or undefined to skip the file

getHasLfsPatterns

@Stability(Experimental)
@NotNull
public Boolean getHasLfsPatterns()

(experimental) Whether the current gitattributes file has any LFS patterns.