edu.wisc.ssec.mcidasv.servermanager

Class LocalAddeEntry.Builder

java.lang.Object

edu.wisc.ssec.mcidasv.servermanager.LocalAddeEntry.Builder

Enclosing class:

LocalAddeEntry

public static class LocalAddeEntry.Builder
extends Object

A builder of (mostly) immutable LocalAddeEntry instances.

Usage example:

    
     LocalAddeEntry entry = new LocalAddeEntry
         .Builder(group, name, format, mask)
         .realtime("Y")
         .range(start, end)
         .type(EntryType.POINT)
         .build();

Only the values required by the Builder constructor are required.

Field Summary

Fields

Modifier and Type	Field and Description
private String	alias
private String	descriptor
private String	end Corresponds to RESOLV.SRV's "R2" section.
private LocalAddeEntry.AddeFormat	format Corresponds to RESOLV.SRV's "MCV" section.
private String	group Corresponds to RESOLV.SRV's "N1" section.
private String	kind Corresponds to RESOLV.SRV's "K" section.
private String	mask Corresponds to RESOLV.SRV's "MASK" section.
private String	name Corresponds to RESOLV.SRV's "C" section.
private boolean	realtime Corresponds to RESOLV.SRV's "RT" section.
private LocalAddeEntry.ServerName	safeKind Defaults to LocalAddeEntry.ServerName.INVALID.
private String	start Corresponds to RESOLV.SRV's "R1" section.
private AddeEntry.EntryStatus	status Defaults to AddeEntry.EntryStatus.INVALID.
private boolean	temporary
private AddeEntry.EntryType	type Corresponds to RESOLV.SRV's "TYPE" section.

Constructor Summary

Constructors

Constructor and Description
Builder(Map<String,String> map)
Builder(String name, String group, String mask, LocalAddeEntry.AddeFormat format) Creates a new LocalAddeEntry "builder" with the required fields for a LocalAddeEntry object.

Method Summary

Modifier and Type	Method and Description
LocalAddeEntry.Builder	alias(String alias)
LocalAddeEntry	build()
LocalAddeEntry.Builder	descriptor(String descriptor) This method is currently a no-op.
LocalAddeEntry.Builder	end(String end)
LocalAddeEntry.Builder	kind(String kind)
LocalAddeEntry.Builder	range(String start, String end)
LocalAddeEntry.Builder	realtime(boolean realtime)
LocalAddeEntry.Builder	realtime(String realtimeAsStr)
LocalAddeEntry.Builder	start(String start)
LocalAddeEntry.Builder	status(AddeEntry.EntryStatus status)
LocalAddeEntry.Builder	status(String status)
LocalAddeEntry.Builder	temporary(boolean temporary)
LocalAddeEntry.Builder	temporary(String temporary)
LocalAddeEntry.Builder	type(AddeEntry.EntryType type)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

group

private final String group

Corresponds to RESOLV.SRV's "N1" section.

name

private final String name

Corresponds to RESOLV.SRV's "C" section.

format

private final LocalAddeEntry.AddeFormat format

Corresponds to RESOLV.SRV's "MCV" section.

mask

private final String mask

Corresponds to RESOLV.SRV's "MASK" section.

descriptor

private String descriptor

realtime

private boolean realtime

Corresponds to RESOLV.SRV's "RT" section. Defaults to false.

start

private String start

Corresponds to RESOLV.SRV's "R1" section. Defaults to "1".

end

private String end

Corresponds to RESOLV.SRV's "R2" section. Defaults to "999999".

status

private AddeEntry.EntryStatus status

Defaults to AddeEntry.EntryStatus.INVALID.

type

private AddeEntry.EntryType type

Corresponds to RESOLV.SRV's "TYPE" section. Defaults to IMAGE.

kind

private String kind

Corresponds to RESOLV.SRV's "K" section. Defaults to "NOT_SET".

safeKind

private LocalAddeEntry.ServerName safeKind

Defaults to LocalAddeEntry.ServerName.INVALID.

temporary

private boolean temporary

alias

private String alias

Constructor Detail

Builder

public Builder(Map<String,String> map)

Builder

public Builder(String name,
               String group,
               String mask,
               LocalAddeEntry.AddeFormat format)

Creates a new LocalAddeEntry "builder" with the required fields for a LocalAddeEntry object.

Parameters:

name - Name of the local ADDE dataset.

group - ADDE group name.

mask - Local file mask.

format - Type of data.

Method Detail

descriptor

public LocalAddeEntry.Builder descriptor(String descriptor)

This method is currently a no-op.

Parameters:

descriptor - Local ADDE entry descriptor. Currently ignored.

Returns:

LocalAddeEntry.Builder with ADDE descriptor.

realtime

public LocalAddeEntry.Builder realtime(String realtimeAsStr)

Parameters:

realtimeAsStr - Whether or not the local ADDE entry is "real time".

Returns:

LocalAddeEntry.Builder with ADDE realtime flag.

realtime

public LocalAddeEntry.Builder realtime(boolean realtime)

Parameters:

realtime - Whether or not the local ADDE entry is "real time".

Returns:

LocalAddeEntry.Builder with ADDE realtime flag.

type

public LocalAddeEntry.Builder type(AddeEntry.EntryType type)

Parameters:

type - ADDE data type.

Returns:

LocalAddeEntry.Builder with ADDE data type.

kind

public LocalAddeEntry.Builder kind(String kind)

Parameters:

kind - ADDE server binary used to handle data.

Returns:

LocalAddeEntry.Builder with ADDE kind.

start

public LocalAddeEntry.Builder start(String start)

Parameters:

start - Beginning of local ADDE dataset.

Returns:

LocalAddeEntry.Builder with ADDE dataset "start".

end

public LocalAddeEntry.Builder end(String end)

Parameters:

end - End of local ADDE dataset.

Returns:

LocalAddeEntry.Builder with ADDE dataset "end".

range

public LocalAddeEntry.Builder range(String start,
                                    String end)

Parameters:

start - Beginning of local ADDE dataset.

end - End of local ADDE dataset.

Returns:

LocalAddeEntry.Builder with ADDE dataset "start" and "end" values.

status

public LocalAddeEntry.Builder status(String status)

Parameters:

status - String representation of local ADDE entry status.

Returns:

LocalAddeEntry.Builder with AddeEntry.EntryStatus.

status

public LocalAddeEntry.Builder status(AddeEntry.EntryStatus status)

Parameters:

status - Local ADDE entry status.

Returns:

LocalAddeEntry.Builder with AddeEntry.EntryStatus.

temporary

public LocalAddeEntry.Builder temporary(boolean temporary)

Parameters:

temporary - Whether or not the local ADDE entry will be saved between application sessions.

Returns:

LocalAddeEntry.Builder with the specified temporary status.

temporary

public LocalAddeEntry.Builder temporary(String temporary)

alias

public LocalAddeEntry.Builder alias(String alias)

Parameters:

alias - Set an alias to use for the local ADDE entry.

Returns:

LocalAddeEntry.Builder with the specified alias.

build

public LocalAddeEntry build()

Returns:

New LocalAddeEntry instance.