Dockerfile.CommentInstruction (gradle-docker-plugin 9.3.2 API)

java.lang.Object
- com.bmuschko.gradle.docker.tasks.image.Dockerfile.StringCommandInstruction
- - com.bmuschko.gradle.docker.tasks.image.Dockerfile.CommentInstruction

All Implemented Interfaces:

Dockerfile.Instruction

Enclosing class:

Dockerfile
```
public static class Dockerfile.CommentInstruction
extends Dockerfile.StringCommandInstruction
```
Represents a comment instruction.

Since:

4.0.1

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  static String KEYWORD
- Constructor Summary
  
  Constructors
  Constructor Description
  
  CommentInstruction(String command)
  
  CommentInstruction(Provider<String> commandProvider)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  String getKeyword()
  Gets the keyword of the instruction as used in the Dockerfile.
  - Methods inherited from class com.bmuschko.gradle.docker.tasks.image.Dockerfile.StringCommandInstruction
    getText
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KEYWORD
```
public static final String KEYWORD
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CommentInstruction
```
public CommentInstruction(String command)
```
  - CommentInstruction
```
public CommentInstruction(Provider<String> commandProvider)
```
- Method Detail
  - getKeyword
```
public String getKeyword()
```
    Gets the keyword of the instruction as used in the Dockerfile.
    For example the keyword of the Dockerfile.FromInstruction is FROM.
    
    Returns:
    
    The instruction keyword