Package org.freeplane.api

Class MapTagCategoryInstruction

java.lang.Object

org.freeplane.api.MapTagCategoryInstruction

public class MapTagCategoryInstruction
extends Object

Single explicit edit operation for the map's tag categories. For MapTagCategoryInstructionType.ADD_TAG, path is the full target path to create when targetLocation is MapTagTargetLocation.CATEGORIZED. Missing parent categorized tags on that path are created automatically by the same edit call. For categorized MapTagCategoryInstructionType.MOVE_TAG, missing parent categorized tags on newParentPath are also created automatically by the same edit call. When targetLocation is MapTagTargetLocation.UNCATEGORIZED, path must contain exactly one segment and Java callers should pass an empty list for newParentPath.

Since:

1.13.3

Constructor Summary

Constructors

Constructor	Description
MapTagCategoryInstruction(MapTagCategoryInstructionType type, List<String> path, String newName, List<String> newParentPath, MapTagTargetLocation targetLocation, Integer index, String color, String newSeparator)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getColor()	Returns the replacement color for color updates.
Integer	getIndex()	Returns the optional insertion index for move operations.
String	getNewName()	Returns the replacement name for rename operations.
List<String>	getNewParentPath()	Returns the target parent path for move operations.
String	getNewSeparator()	Returns the replacement category separator.
List<String>	getPath()	Returns the target path.
MapTagTargetLocation	getTargetLocation()	Returns the target placement for add and move operations.
MapTagCategoryInstructionType	getType()	Returns the operation kind.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Details

MapTagCategoryInstruction

public MapTagCategoryInstruction(MapTagCategoryInstructionType type,
 List<String> path,
 String newName,
 List<String> newParentPath,
 MapTagTargetLocation targetLocation,
 Integer index,
 String color,
 String newSeparator)

Parameters:

type - operation kind

path - target path; for categorized add operations, the full target path to create, not the parent path

newName - replacement name for rename operations

newParentPath - target parent path for categorized move operations; an empty list means the top level; missing categorized parents are created automatically; for uncategorized move operations, pass an empty list

targetLocation - target placement for add and move operations

index - optional insertion index for move operations

color - replacement color for add and color update operations

newSeparator - replacement category separator

Method Details

getType

public MapTagCategoryInstructionType getType()

Returns the operation kind.

getPath

public List<String> getPath()

Returns the target path. For categorized add operations, this is the full target path to create.

getNewName

public String getNewName()

Returns the replacement name for rename operations.

getNewParentPath

public List<String> getNewParentPath()

Returns the target parent path for move operations.

getTargetLocation

public MapTagTargetLocation getTargetLocation()

Returns the target placement for add and move operations.

getIndex

public Integer getIndex()

Returns the optional insertion index for move operations.

getColor

public String getColor()

Returns the replacement color for color updates.

getNewSeparator

public String getNewSeparator()

Returns the replacement category separator.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object