TagEdit

java.lang.Object
- com.inductiveautomation.ignition.common.tags.config.TagEdit

All Implemented Interfaces:

java.io.Serializable
```
public class TagEdit
extends java.lang.Object
implements java.io.Serializable
```
Contains the local config changes of a tag. Used with gateway communication where inherited props aren't necessary.

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMemberEdit(TagEdit member)` Member edits are tags beneath this one.
`static TagEdit`	`createDelete(TagPath path)`
`static TagEdit`	`createEdit(TagPath path)` Creates an edit for the path with an empty property set that can be modified through getConfig()
`static TagEdit`	`createEdit(TagPath path, BoundPropertySet config)` See createNew() for more details, but in short, only use this version when you know you want to edit/overwrite a specific existing tag.
`static TagEdit`	`createNew(TagPath path, BoundPropertySet config)` Creates a new tag edit.
`static TagEdit`	`createRename(TagPath originalPath, java.lang.String name)`
`BoundPropertySet`	`getConfig()`
`java.util.List<TagEdit>`	`getMemberEdits()` Non-modifiable list of member edits.
`TagPath`	`getPath()`
`boolean`	`isNew()`
`boolean`	`isRemoved()`
`boolean`	`isRename()`
`void`	`setPath(TagPath path)`
`java.lang.String`	`toString()`

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

- Method Detail
  - createEdit
```
public static TagEdit createEdit(TagPath path)
```
    Creates an edit for the path with an empty property set that can be modified through getConfig()
  - createNew
```
public static TagEdit createNew(TagPath path,
                                BoundPropertySet config)
```
    Creates a new tag edit. This is the creation function that should be used most often, if there's any doubt whether we want to create or edit a tag. createEdit() should be called only when we know we are editing a specific tag instance. We can edit tags even with this "new" TagEdit, it will just require the collision policy to be Overwrite.
  - createEdit
```
public static TagEdit createEdit(TagPath path,
                                 BoundPropertySet config)
```
    See createNew() for more details, but in short, only use this version when you know you want to edit/overwrite a specific existing tag.
  - createDelete
```
public static TagEdit createDelete(TagPath path)
```
  - createRename
```
public static TagEdit createRename(TagPath originalPath,
                                   java.lang.String name)
```
  - getPath
```
public TagPath getPath()
```
  - setPath
```
public void setPath(TagPath path)
```
  - getConfig
```
public BoundPropertySet getConfig()
```
  - isRemoved
```
public boolean isRemoved()
```
  - isRename
```
public boolean isRename()
```
  - isNew
```
public boolean isNew()
```
  - addMemberEdit
```
public void addMemberEdit(TagEdit member)
```
    Member edits are tags beneath this one. They should have relative paths (this function will make the path relative if not already).
  - getMemberEdits
```
public java.util.List<TagEdit> getMemberEdits()
```
    Non-modifiable list of member edits. Won't return null.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class TagEdit

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createEdit

createNew

createEdit

createDelete

createRename

getPath

setPath

getConfig

isRemoved

isRename

isNew

addMemberEdit

getMemberEdits

toString