Module com.thecoderscorner.tcmenu.javaapi

Package com.thecoderscorner.menu.persist

Class JsonMenuItemSerializer

java.lang.Object

com.thecoderscorner.menu.persist.JsonMenuItemSerializer

public class JsonMenuItemSerializer
extends Object

Creates a menu serializer instance that can convert menu structures to and from JSON format. In the simplest case just create a new instance of the class and you can use it to convert between formats.

     var jsonSerializer = new JsonMenuItemSerializer();
     var tree = jsonSerializer.newMenuTreeWithItems(textCopiedFromTcMenuDesigner);
     var json = jsonSerializer.itemsToCopyText(MenuTree.ROOT, tree);
 

Constructor Summary

Constructors

Constructor	Description
JsonMenuItemSerializer()
JsonMenuItemSerializer(Consumer<com.google.gson.GsonBuilder> builder)

Method Summary

Modifier and Type	Method	Description
static boolean	checkItemValueCanPersist(PersistedMenu persistedMenu)	There are some menu types that should not have a default value, these generally don't have a value associated with them that can be easily saved, such as lists, action items, builder items and submenus.
List<PersistedMenu>	copyTextToItems(String items)
com.google.gson.Gson	getGson()
String	itemsToCopyText(MenuItem startingPoint, MenuTree tree)
MenuTree	newMenuTreeWithItems(String tcMenuCopy)
List<PersistedMenu>	populateListInOrder(SubMenuItem node, MenuTree menuTree, boolean processingRoot)

Methods inherited from class java.lang.Object

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

Constructor Details

JsonMenuItemSerializer

public JsonMenuItemSerializer()

JsonMenuItemSerializer

public JsonMenuItemSerializer(Consumer<com.google.gson.GsonBuilder> builder)

Method Details

getGson

public com.google.gson.Gson getGson()

populateListInOrder

public List<PersistedMenu> populateListInOrder(SubMenuItem node,
 MenuTree menuTree,
 boolean processingRoot)

itemsToCopyText

public String itemsToCopyText(MenuItem startingPoint,
 MenuTree tree)

copyTextToItems

public List<PersistedMenu> copyTextToItems(String items)

newMenuTreeWithItems

public MenuTree newMenuTreeWithItems(String tcMenuCopy)

checkItemValueCanPersist

public static boolean checkItemValueCanPersist(PersistedMenu persistedMenu)

There are some menu types that should not have a default value, these generally don't have a value associated with them that can be easily saved, such as lists, action items, builder items and submenus.

Parameters:

persistedMenu - the item to check

Returns:

true if the item value can be persisted, otherwise false