Package org.apache.plc4x.plugins.codegenerator.language.mspec.protocol

Schnittstelle ProtocolHelpers

Alle Superschnittstellen:

org.apache.plc4x.plugins.codegenerator.protocol.Protocol

public interface ProtocolHelpers
extends org.apache.plc4x.plugins.codegenerator.protocol.Protocol

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
default InputStream	getMspecStream()	Returns a mspec stream by using Protocol.getName()
default InputStream	getMspecStream(String mspecName)	Returns a mspec stream for a give name
default String	getPackageName()
default String	getSanitizedName()

Von Schnittstelle geerbte Methoden org.apache.plc4x.plugins.codegenerator.protocol.Protocol

getName, getTypeContext, getVersion

Methodendetails

getMspecStream

default InputStream getMspecStream()
                            throws org.apache.plc4x.plugins.codegenerator.types.exceptions.GenerationException

Returns a mspec stream by using Protocol.getName()

Gibt zurück:

the InputStream of the referenced mspecName

Löst aus:

org.apache.plc4x.plugins.codegenerator.types.exceptions.GenerationException - if the mspec can't be found.

getMspecStream

default InputStream getMspecStream(String mspecName)
                            throws org.apache.plc4x.plugins.codegenerator.types.exceptions.GenerationException

Returns a mspec stream for a give name

Parameter:

mspecName - the name without the .mspec extension

Gibt zurück:

the InputStream of the referenced mspecName

Löst aus:

org.apache.plc4x.plugins.codegenerator.types.exceptions.GenerationException - if the mspec can't be found.

getSanitizedName

default String getSanitizedName()

Gibt zurück:

Protocol.getName() in sanitized form

getPackageName

default String getPackageName()

Gibt zurück:

the package name