Resource file that may have the default value supplied by jpackage. It can be overridden by a file from resource directory set with --resource-dir jpackage parameter. Resource has default name and public name. Default name is the name of a file in jdk.jpackage.internal.resources package that provides the default value of the resource. Public name is a path relative to resource directory to a file with custom value of the resource. Use #setPublicName to set the public name. If #setPublicName was not called, name of file passed in #saveToFile function will be used as a public name. Use #setExternal to set arbitrary file as a source of resource. If non-null value was passed in #setExternal call that value will be used as a path to file to copy in the destination file passed in #saveToFile function call.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static interface	OverridableResource.ResourceConsumer
pack-priv static enum	OverridableResource.Source
private static interface	OverridableResource.SourceHandler

Field Summary

Modifier and Type	Field and Description
private String	category
private final String	defaultName
private final Function<String, InputStream>	defaultResourceGetter
private Path	externalPath
private Path	logPublicName
private Path	publicName
private Path	resourceDir
private Map<OverridableResource.Source, OverridableResource.SourceHandler>	sources
private Map<String, String>	substitutionData

Constructor Summary

Access	Constructor and Description
pack-priv	OverridableResource()
pack-priv	OverridableResource(String defaultName, Function<String, InputStream> defaultResourceGetter)
pack-priv	OverridableResource(String defaultName, Class<?> resourceLocator)

Method Summary

Modifier and Type	Method and Description
pack-priv OverridableResource	addSubstitutionDataEntry(String key, String value)
pack-priv String	getDefaultName()
pack-priv Path	getExternalPath()
private OverridableResource.SourceHandler	getHandler(OverridableResource.Source sourceType)
private String	getPrintableCategory()
pack-priv Path	getPublicName()
pack-priv Path	getResourceDir()
private void	noDefault(OverridableResource.ResourceConsumer dest)
pack-priv OverridableResource.Source	probe()
private void	processResourceStream(InputStream rawResource, OverridableResource.ResourceConsumer dest)
private Path	resourceName(OverridableResource.ResourceConsumer dest)
pack-priv OverridableResource.Source	saveInFolder(Path folderPath)
pack-priv OverridableResource.Source	saveToFile(Path dest)
pack-priv OverridableResource.Source	saveToFile(File dest)
pack-priv OverridableResource.Source	saveToStream(OutputStream dest)
private OverridableResource.Source	sendToConsumer(OverridableResource.ResourceConsumer consumer)
pack-priv OverridableResource	setCategory(String v)
pack-priv OverridableResource	setExternal(Path v)
pack-priv OverridableResource	setExternal(File v)
pack-priv OverridableResource	Returns: this setLogPublicName(Path v) Set name of file to look for in resource dir to put in verbose log.
pack-priv OverridableResource	setLogPublicName(String v)
pack-priv OverridableResource	Returns: this setPublicName(Path v) Set name of file to look for in resource dir.
pack-priv OverridableResource	setPublicName(String v)
pack-priv OverridableResource	setResourceDir(Path v)
pack-priv OverridableResource	setResourceDir(File v)
pack-priv OverridableResource	setSourceOrder(OverridableResource.Source... v)
pack-priv OverridableResource	setSubstitutionData(Map<String, String> v)
private static Stream<String>	substitute(Stream<String> lines, Map<String, String> substitutionData)
private static Path	toPath(File v)
private boolean	useDefault(OverridableResource.ResourceConsumer dest)
private boolean	useExternal(OverridableResource.ResourceConsumer dest)
private boolean	useResourceDir(OverridableResource.ResourceConsumer dest)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

category	back to summary
private String category

defaultName	back to summary
private final String defaultName

defaultResourceGetter	back to summary
private final Function<String, InputStream> defaultResourceGetter

externalPath	back to summary
private Path externalPath

logPublicName	back to summary
private Path logPublicName

publicName	back to summary
private Path publicName

resourceDir	back to summary
private Path resourceDir

sources	back to summary
private Map<OverridableResource.Source, OverridableResource.SourceHandler> sources

substitutionData	back to summary
private Map<String, String> substitutionData

Constructor Detail

OverridableResource	back to summary
pack-priv OverridableResource()

OverridableResource	back to summary
pack-priv OverridableResource(String defaultName, Function<String, InputStream> defaultResourceGetter)

OverridableResource	back to summary
pack-priv OverridableResource(String defaultName, Class<?> resourceLocator)

Method Detail

addSubstitutionDataEntry	back to summary
pack-priv OverridableResource addSubstitutionDataEntry(String key, String value)

getDefaultName	back to summary
pack-priv String getDefaultName()

getExternalPath	back to summary
pack-priv Path getExternalPath()

getHandler	back to summary
private OverridableResource.SourceHandler getHandler(OverridableResource.Source sourceType)

getPrintableCategory	back to summary
private String getPrintableCategory()

getPublicName	back to summary
pack-priv Path getPublicName()

getResourceDir	back to summary
pack-priv Path getResourceDir()

noDefault	back to summary
private void noDefault(OverridableResource.ResourceConsumer dest)

probe	back to summary
pack-priv OverridableResource.Source probe()

processResourceStream	back to summary
private void processResourceStream(InputStream rawResource, OverridableResource.ResourceConsumer dest) throws IOException

resourceName	back to summary
private Path resourceName(OverridableResource.ResourceConsumer dest)

saveInFolder	back to summary
pack-priv OverridableResource.Source saveInFolder(Path folderPath) throws IOException

saveToFile	back to summary
pack-priv OverridableResource.Source saveToFile(Path dest) throws IOException

saveToFile	back to summary
pack-priv OverridableResource.Source saveToFile(File dest) throws IOException

saveToStream	back to summary
pack-priv OverridableResource.Source saveToStream(OutputStream dest) throws IOException

sendToConsumer	back to summary
private OverridableResource.Source sendToConsumer(OverridableResource.ResourceConsumer consumer) throws IOException

setCategory	back to summary
pack-priv OverridableResource setCategory(String v)

setExternal	back to summary
pack-priv OverridableResource setExternal(Path v)

setExternal	back to summary
pack-priv OverridableResource setExternal(File v)

setLogPublicName	back to summary
pack-priv OverridableResource setLogPublicName(Path v) Set name of file to look for in resource dir to put in verbose log. Returns:OverridableResource this

setLogPublicName

back to summary

pack-priv OverridableResource setLogPublicName(Path v)

Set name of file to look for in resource dir to put in verbose log.

Returns:OverridableResource: this

setLogPublicName	back to summary
pack-priv OverridableResource setLogPublicName(String v)

setPublicName	back to summary
pack-priv OverridableResource setPublicName(Path v) Set name of file to look for in resource dir. Returns:OverridableResource this

setPublicName

back to summary

pack-priv OverridableResource setPublicName(Path v)

Set name of file to look for in resource dir.

Returns:OverridableResource: this

setPublicName	back to summary
pack-priv OverridableResource setPublicName(String v)

setResourceDir	back to summary
pack-priv OverridableResource setResourceDir(Path v)

setResourceDir	back to summary
pack-priv OverridableResource setResourceDir(File v)

setSourceOrder	back to summary
pack-priv OverridableResource setSourceOrder(OverridableResource.Source... v)

setSubstitutionData	back to summary
pack-priv OverridableResource setSubstitutionData(Map<String, String> v)

substitute	back to summary
private static Stream<String> substitute(Stream<String> lines, Map<String, String> substitutionData)

toPath	back to summary
private static Path toPath(File v)

useDefault	back to summary
private boolean useDefault(OverridableResource.ResourceConsumer dest) throws IOException

useExternal	back to summary
private boolean useExternal(OverridableResource.ResourceConsumer dest) throws IOException

useResourceDir	back to summary
private boolean useResourceDir(OverridableResource.ResourceConsumer dest) throws IOException

jdk.jpackage.internal back to summary

private Interface OverridableResource.ResourceConsumer

Method Summary

Modifier and Type	Method and Description
public void	consume(InputStream in)
public Path	publicName()

Method Detail

consume	back to summary
public void consume(InputStream in) throws IOException

publicName	back to summary
public Path publicName()

jdk.jpackage.internal back to summary

pack-priv final Enum OverridableResource.Source

Class Inheritance

extends Enum<OverridableResource.Source>

java.lang.Object
java.lang.Enum
jdk.jpackage.internal.OverridableResource.Source

Field Summary

Modifier and Type	Field and Description
public static final OverridableResource.Source	DefaultResource
public static final OverridableResource.Source	External
public static final OverridableResource.Source	ResourceDir

Constructor Summary

Access	Constructor and Description
private	Source()

Method Summary

Modifier and Type	Method and Description
public static OverridableResource.Source	valueOf(String name)
public static OverridableResource.Source[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DefaultResource	back to summary
public static final OverridableResource.Source DefaultResource

External	back to summary
public static final OverridableResource.Source External

ResourceDir	back to summary
public static final OverridableResource.Source ResourceDir

Constructor Detail

Source	back to summary
private Source()

Method Detail

valueOf	back to summary
public static OverridableResource.Source valueOf(String name)

values	back to summary
public static OverridableResource.Source[] values()

pack-priv final Class OverridableResource

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Interface OverridableResource.ResourceConsumer

Method Summary

Method Detail

pack-priv final Enum OverridableResource.Source

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Interface OverridableResource.SourceHandler

Method Summary

Method Detail