Module org.jgrapht.io

Package org.jgrapht.nio.gml

Enum GmlExporter.Parameter

java.lang.Object

java.lang.Enum<GmlExporter.Parameter>

org.jgrapht.nio.gml.GmlExporter.Parameter

All Implemented Interfaces:

Serializable, Comparable<GmlExporter.Parameter>, java.lang.constant.Constable

Enclosing class:

GmlExporter<V,E>

public static enum GmlExporter.Parameter
extends Enum<GmlExporter.Parameter>

Parameters that affect the behavior of the GmlExporter exporter.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ESCAPE_STRINGS_AS_JAVA	If set the exporter escapes all strings as Java strings, otherwise no escaping is performed.
EXPORT_CUSTOM_EDGE_ATTRIBUTES	If set the exporter outputs all custom edge attributes.
EXPORT_CUSTOM_VERTEX_ATTRIBUTES	If set the exporter outputs all custom vertex attributes.
EXPORT_EDGE_LABELS	If set the exporter outputs edge labels.
EXPORT_EDGE_WEIGHTS	If set the exporter outputs edge weights
EXPORT_VERTEX_LABELS	If set the exporter outputs vertex labels.

Method Summary

Modifier and Type	Method	Description
static GmlExporter.Parameter	valueOf(String name)	Returns the enum constant of this type with the specified name.
static GmlExporter.Parameter[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EXPORT_EDGE_LABELS

public static final GmlExporter.Parameter EXPORT_EDGE_LABELS

If set the exporter outputs edge labels. The labels are found from the edge attribute provider of the importer using the key "label".

EXPORT_EDGE_WEIGHTS

public static final GmlExporter.Parameter EXPORT_EDGE_WEIGHTS

If set the exporter outputs edge weights

EXPORT_CUSTOM_EDGE_ATTRIBUTES

public static final GmlExporter.Parameter EXPORT_CUSTOM_EDGE_ATTRIBUTES

If set the exporter outputs all custom edge attributes. The attributes are located from the edge attribute provider of the importer. Note that these attributes have lowest priority compared to special handled ones like "label", or "weight" and cannot contain special keys like "id", "source" and "target".

EXPORT_VERTEX_LABELS

public static final GmlExporter.Parameter EXPORT_VERTEX_LABELS

If set the exporter outputs vertex labels. The labels are found from the vertex attribute provider of the importer using the key "label".

EXPORT_CUSTOM_VERTEX_ATTRIBUTES

public static final GmlExporter.Parameter EXPORT_CUSTOM_VERTEX_ATTRIBUTES

If set the exporter outputs all custom vertex attributes. The attributes are located from the vertex attribute provider of the importer. Note that these attributes have lowest priority compared to special handled ones like "label" and cannot contain special keys like "id".

ESCAPE_STRINGS_AS_JAVA

public static final GmlExporter.Parameter ESCAPE_STRINGS_AS_JAVA

If set the exporter escapes all strings as Java strings, otherwise no escaping is performed.

Method Details

values

public static GmlExporter.Parameter[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static GmlExporter.Parameter valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null