org.ops4j.pax.tinybundles.core

Interface TinyBundle

All Known Implementing Classes:

TinyBundleImpl

public interface TinyBundle

Main type when making bundles with the TinyBundles library. Get an instance from TinyBundles Factory, add resources and call build() to go to the final step.

Since:

Apr 9, 2009

Author:

Toni Menzel (tonit)

Method Summary

Methods

Modifier and Type	Method and Description
TinyBundle	add(Class<?> content) Add a class to the current bundle.
TinyBundle	add(Class<?> content, InnerClassStrategy strategy) Add a class to the current bundle.
TinyBundle	add(String name, InputStream content) Add a resource to the current bundle (to be built).
TinyBundle	add(String name, URL content) Add a resource to the current bundle (to be built).
InputStream	build() Shortcut to build(BuildStrategy) witth buildstrategy = TinyBundles.withClassicBuilder().
InputStream	build(BuildStrategy builder) When you are done adding stuff to *this* you can call this method to go to next step.
String	getHeader(String key) Get header value.
TinyBundle	read(InputStream input) Read an existing bundle or jar into Tinybundles for modification.
TinyBundle	read(InputStream input, boolean readData) Read an existing bundle or jar into Tinybundles for modification.
TinyBundle	remove(Class<?> content) remove a class to the current bundle.
TinyBundle	removeHeader(String key) Remove a previously added header.
TinyBundle	removeResource(String key) Remove a previously added resource.
TinyBundle	set(String key, String value) Set header values that go into the Manifest.

Method Detail

add

TinyBundle add(String name,
             URL content)

Add a resource to the current bundle (to be built).

Parameters:

name - final path inside the jar

content - content to be copied into bundle.

Returns:

*this*

add

TinyBundle add(String name,
             InputStream content)

Add a resource to the current bundle (to be built).

Parameters:

name - final path inside the jar

content - content to be copied into bundle.

Returns:

*this*

add

TinyBundle add(Class<?> content)

Add a class to the current bundle. Uses InnerClassStrategy.ALL

Parameters:

content - content to be copied into bundle.

Returns:

this

add

TinyBundle add(Class<?> content,
             InnerClassStrategy strategy)

Add a class to the current bundle.

Parameters:

content -

remove

TinyBundle remove(Class<?> content)

remove a class to the current bundle.

Parameters:

content - class to be removed

Returns:

*this*

build

InputStream build(BuildStrategy builder)

When you are done adding stuff to *this* you can call this method to go to next step. The BND based builder will be used for your convenience.

Parameters:

builder - builder to be used.

Returns:

Next step in the bundle making process.

build

InputStream build()

Shortcut to build(BuildStrategy) witth buildstrategy = TinyBundles.withClassicBuilder().

Returns:

Next step in the bundle making process.

set

TinyBundle set(String key,
             String value)

Set header values that go into the Manifest. Note that if BND is used to build this bundle, those instructions will be passed to BND as is.

Parameters:

key - a key

value - a value

Returns:

this

removeResource

TinyBundle removeResource(String key)

Remove a previously added resource. Usually usefull if you loaded an existing bundle into TinyBundles before.

Parameters:

key - a key as String

Returns:

this

removeHeader

TinyBundle removeHeader(String key)

Remove a previously added header. Usually usefull if you loaded an existing bundle into TinyBundles before.

Parameters:

key - a key as String

Returns:

this

read

TinyBundle read(InputStream input)

Read an existing bundle or jar into Tinybundles for modification.

Parameters:

input - stream of JarInputStream

Returns:

this

read

TinyBundle read(InputStream input,
              boolean readData)

Read an existing bundle or jar into Tinybundles for modification.

Parameters:

input - stream of JarInputStream

Returns:

this

getHeader

String getHeader(String key)

Get header value.