YXmlHook (keikai-doc-collab 7.0.0.FL.20250124 API)

java.lang.Object
- io.keikai.doc.collab.types.AbstractType<YMapEvent>
- - io.keikai.doc.collab.types.YMap<T>
  - - io.keikai.doc.collab.types.YXmlHook<T>

All Implemented Interfaces:

java.lang.Iterable<java.util.Map.Entry<java.lang.String,Item>>
```
public class YXmlHook<T>
extends YMap<T>
```

Field Summary
- Fields inherited from class io.keikai.doc.collab.types.AbstractType
  _doc, _length, _map, _searchMarker

Constructor Summary

Constructors
Constructor Description

YXmlHook(java.lang.String hookName)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`YXmlHook<T>`	`clone()`	Makes a copy of this data type that can be included somewhere else.
`YXmlHook`	`copy()`	Creates an Item with the same effect as this Item (without position effect)
`java.lang.String`	`getHookName()`
`static YXmlHook`	`readYXmlHook(UpdateDecoder decoder)`	Static method to read a YXmlHook from a decoder.
`void`	`setHookName(java.lang.String hookName)`
`void`	`write(UpdateEncoder encoder)`	Transform the properties of this type to binary and write it to a BinaryEncoder.

Methods inherited from class io.keikai.doc.collab.types.YMap
callObserver, clear, delete, entries, forEach, get, has, integrate, iterator, keys, readYMap, set, size, toJSON, values

Methods inherited from class io.keikai.doc.collab.types.AbstractType
callTypeObservers, createMapIterator, getDeepEventHandler, getDoc, getFirst, getItem, getMap, getParent, getSearchMarker, getStart, getTypeChildren, isParentOf, length, observe, observe, observeDeep, setLength, setMap, setStart, typeListCreateIterator, typeListDelete, typeListForEach, typeListForEachSnapshot, typeListGet, typeListInsertGenerics, typeListInsertGenericsAfter, typeListMap, typeListPushGenerics, typeListSlice, typeListToArray, typeListToArraySnapshot, typeMapDelete, typeMapGet, typeMapGetAll, typeMapGetAllSnapshot, typeMapGetSnapshot, typeMapHas, typeMapSet, unobserve, unobserveDeep

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - YXmlHook
```
public YXmlHook(java.lang.String hookName)
```
    Parameters:
    
    hookName - nodeName of the DOM Node.
- Method Detail
  - getHookName
```
public java.lang.String getHookName()
```
  - setHookName
```
public void setHookName(java.lang.String hookName)
```
  - copy
```
public YXmlHook copy()
```
    Creates an Item with the same effect as this Item (without position effect)
    
    Overrides:
    
    copy in class YMap<T>
    
    Returns:
    
    A new copy of this YMap.
  - clone
```
public YXmlHook<T> clone()
```
    Makes a copy of this data type that can be included somewhere else. Note that the content is only readable _after_ it has been included somewhere in the Ydoc.
    
    Overrides:
    
    clone in class YMap<T>
    
    Returns:
    
    YXmlHook
  - write
```
public void write(UpdateEncoder encoder)
```
    Transform the properties of this type to binary and write it to a BinaryEncoder. This is called when this Item is sent to a remote peer.
    
    Overrides:
    
    write in class YMap<T>
    
    Parameters:
    
    encoder - The encoder to write data to.
  - readYXmlHook
```
public static YXmlHook readYXmlHook(UpdateDecoder decoder)
```
    Static method to read a YXmlHook from a decoder.
    
    Parameters:
    
    decoder - The decoder to read data from.
    
    Returns:
    
    A new YXmlHook instance.