Package org.opendaylight.yangtools.plugin.generator.api

Interface GeneratedFile

All Superinterfaces:

Immutable, MutationBehaviour<Immutable>

All Known Implementing Classes:

AbstractGeneratedFile, AbstractGeneratedTextFile

@Beta
@NonNullByDefault
public interface GeneratedFile
extends Immutable

The contents of a generated file and its GeneratedFileLifecycle.

Author:

Robert Varga

Method Summary

Modifier and Type	Method	Description
GeneratedFileLifecycle	getLifecycle()	Return the lifecycle governing this file.
static GeneratedFile	of(GeneratedFileLifecycle lifecycle, ByteSource body)	Create a new GeneratedFile with the specified ByteSource body.
static GeneratedFile	of(GeneratedFileLifecycle lifecycle, CharSource body)	Create a new GeneratedFile with the specified CharSource body.
static GeneratedFile	of(GeneratedFileLifecycle lifecycle, CharSequence body)	Create a new GeneratedFile with the specified CharSequence body.
void	writeBody(OutputStream output)	Write the body of this file into specified OutputStream.

Method Detail

getLifecycle

GeneratedFileLifecycle getLifecycle()

Return the lifecycle governing this file.

Returns:

Governing lifecycle

writeBody

void writeBody(OutputStream output)
        throws IOException

Write the body of this file into specified OutputStream.

Parameters:

output - stream where to write the output

Throws:

IOException - when the stream reports an IOException

of

static GeneratedFile of(GeneratedFileLifecycle lifecycle,
                        CharSequence body)

Create a new GeneratedFile with the specified CharSequence body. The body will be encoded in StandardCharsets.UTF_8.

Parameters:

lifecycle - File lifecycle

body - File body

Returns:

A GeneratedFile.

Throws:

NullPointerException - if any argument is null

of

static GeneratedFile of(GeneratedFileLifecycle lifecycle,
                        CharSource body)

Create a new GeneratedFile with the specified CharSource body. The body will be encoded in StandardCharsets.UTF_8.

Parameters:

lifecycle - File lifecycle

body - File body

Returns:

A GeneratedFile.

Throws:

NullPointerException - if any argument is null

of

static GeneratedFile of(GeneratedFileLifecycle lifecycle,
                        ByteSource body)

Create a new GeneratedFile with the specified ByteSource body. The body will be written as is.

Parameters:

lifecycle - File lifecycle

body - File body

Returns:

A GeneratedFile.

Throws:

NullPointerException - if any argument is null