HeaderSource (SNAP Engine API)

java.lang.Object
- org.esa.snap.core.gpf.graph.HeaderSource

public class HeaderSource
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class HeaderSource.Converter

Constructor Summary

Constructors
Constructor Description

HeaderSource()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getDescription()`	Gets the description for this source product.
`String`	`getLocation()`	Gets the location of the source product.
`String`	`getName()`	Gets the name of source product.
`boolean`	`isOptional()`
`void`	`setDescription(String description)`	Sets the description for this source product.
`void`	`setLocation(String location)`	Sets the location of the source product.
`void`	`setName(String name)`	Sets the name of the source product.
`void`	`setOptional(boolean optional)`	Sets if the source product is optional.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HeaderSource
```
public HeaderSource()
```
- Method Detail
  - getName
```
public String getName()
```
    Gets the name of source product.
    
    Returns:
    
    the name
  - setName
```
public void setName(String name)
```
    Sets the name of the source product.
    
    Parameters:
    
    name - the name to set
  - getLocation
```
public String getLocation()
```
    Gets the location of the source product.
    
    Returns:
    
    the source product location
  - setLocation
```
public void setLocation(String location)
```
    Sets the location of the source product.
    
    Parameters:
    
    location -
  - isOptional
```
public boolean isOptional()
```
    Returns:
    
    true if the source product is optional. In this case the field value thus may be null. Defaults to false.
  - setOptional
```
public void setOptional(boolean optional)
```
    Sets if the source product is optional.
    
    Parameters:
    
    optional -
  - getDescription
```
public String getDescription()
```
    Gets the description for this source product.
    
    Returns:
    
    the descriptioon
  - setDescription
```
public void setDescription(String description)
```
    Sets the description for this source product.
    
    Parameters:
    
    description -