com.pubmatic.sdk.video.xmlserialiser

Class POBNodeBuilder

java.lang.Object

com.pubmatic.sdk.video.xmlserialiser.POBNodeBuilder

public class POBNodeBuilder
extends java.lang.Object

Builder Class containing a Node which is used to build a POBXMLNodeListener model class

Constructor Summary

Constructors

Constructor and Description
POBNodeBuilder(org.w3c.dom.Node node) Constructor to instantiate the class object with provided argument

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttributeValue(java.lang.String attPath) Returns the value of current node attribute for provided attribute name
org.w3c.dom.Node	getNode(java.lang.String path) Retrieves a sub-node at provide xpath and returns it.
java.lang.String	getNodeName() Returns the name of current node
<T extends POBXMLNodeListener> T	getNodeObject(java.lang.String path, java.lang.Class<T> elementType) Creates and returns an instance of provided class type for provided xPath
java.lang.String	getNodeValue() Returns the value of current node
java.lang.String	getNodeValue(java.lang.String path) Returns the value of sub-node
<T extends POBXMLNodeListener> java.util.List<T>	getObjectList(java.lang.String path, java.lang.Class<T> elementType) Creates and returns a list of provided class type for provided xPath
java.util.List<java.lang.String>	getStringList(java.lang.String path) Creates and returns a list of node values with provided xPath

Methods inherited from class java.lang.Object

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

Constructor Detail

POBNodeBuilder

public POBNodeBuilder(@Nullable
                      org.w3c.dom.Node node)

Constructor to instantiate the class object with provided argument

Parameters:

node - xml node

Method Detail

getNodeName

@Nullable
public java.lang.String getNodeName()

Returns the name of current node

Returns:

current xml node name

getNodeValue

@Nullable
public java.lang.String getNodeValue()

Returns the value of current node

Returns:

current xml node value

getObjectList

@Nullable
public <T extends POBXMLNodeListener> java.util.List<T> getObjectList(@NonNull
                                                                                java.lang.String path,
                                                                                @NonNull
                                                                                java.lang.Class<T> elementType)

Creates and returns a list of provided class type for provided xPath

Type Parameters:

T - Any model class from Vast module like POBTracking, POBMediaFile, POBCompanion, POBAdVerification etc

Parameters:

path - sub-node relative xpath of sub-node from current node

elementType - class of which instance to be created

Returns:

list of provided class type

getStringList

@Nullable
public java.util.List<java.lang.String> getStringList(@NonNull
                                                                java.lang.String path)

Creates and returns a list of node values with provided xPath

Parameters:

path - sub-node relative xpath of sub-node from current node

Returns:

list of values provided class

getNodeValue

@Nullable
public java.lang.String getNodeValue(@NonNull
                                               java.lang.String path)

Returns the value of sub-node

Parameters:

path - sub-node relative xpath of sub-node from current node

Returns:

xml sub-node value

getNode

@Nullable
public org.w3c.dom.Node getNode(@NonNull
                                          java.lang.String path)

Retrieves a sub-node at provide xpath and returns it.

Parameters:

path - relative xpath of sub-node from current node

Returns:

Node based on provided xpath

getNodeObject

@Nullable
public <T extends POBXMLNodeListener> T getNodeObject(@NonNull
                                                                java.lang.String path,
                                                                @NonNull
                                                                java.lang.Class<T> elementType)

Creates and returns an instance of provided class type for provided xPath

Type Parameters:

T - Any model class from Vast module like POBResource, POBLinear, POBNonLinear etc

Parameters:

path - sub-node relative xpath of sub-node from current node

elementType - class of which list to be created

Returns:

Instance of provided class type

getAttributeValue

@Nullable
public java.lang.String getAttributeValue(@NonNull
                                                    java.lang.String attPath)

Returns the value of current node attribute for provided attribute name

Parameters:

attPath - attribute xpath from current node

Returns:

current xml node value