mirror of https://github.com/apache/jclouds.git
added javadoc
This commit is contained in:
parent
d841d2e76a
commit
66dc8787ae
|
@ -24,7 +24,12 @@ import com.google.common.annotations.Beta;
|
||||||
import com.google.common.reflect.TypeToken;
|
import com.google.common.reflect.TypeToken;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
* {@link Wrapper} allows access to the provider-specific, or library-driven api
|
||||||
|
* behind an abstraction. One wrapped context can support multiple wrappers.
|
||||||
|
* <p/>
|
||||||
|
* For example, the {@code CloudStackContext} can be wrapped by both
|
||||||
|
* {@code ComputeServiceContext} and {@code LoadBalancerServiceContext}, as the
|
||||||
|
* api covers these features.
|
||||||
*
|
*
|
||||||
* @author Adrian Cole
|
* @author Adrian Cole
|
||||||
*
|
*
|
||||||
|
@ -39,22 +44,24 @@ public interface Wrapper {
|
||||||
TypeToken<?> getWrappedType();
|
TypeToken<?> getWrappedType();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return an object of the specified type to allow access to the wrapped context. If the wrapped
|
* Return an object of the specified type to allow access to the wrapped
|
||||||
* context is not assignable from the supplied type, an {@link IllegalArgumentException} is
|
* context. If the wrapped context is not assignable from the supplied type,
|
||||||
* thrown.
|
* an {@link IllegalArgumentException} is thrown.
|
||||||
*
|
*
|
||||||
* @param type
|
* @param type
|
||||||
* the type of the context to be returned. The wrapped context must be assignable from
|
* the type of the context to be returned. The wrapped context must
|
||||||
* this type.
|
* be assignable from this type.
|
||||||
* @return an instance of the specified type
|
* @return an instance of the specified type
|
||||||
* @throws IllegalArgumentException
|
* @throws IllegalArgumentException
|
||||||
* if the wrapped context is not assignable from the specified class.
|
* if the wrapped context is not assignable from the specified
|
||||||
|
* class.
|
||||||
* @see #getWrappedType()
|
* @see #getWrappedType()
|
||||||
*/
|
*/
|
||||||
<C extends Closeable> C unwrap(TypeToken<C> type) throws IllegalArgumentException;
|
<C extends Closeable> C unwrap(TypeToken<C> type) throws IllegalArgumentException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* shortcut for {@code unwrap(TypeToken.of(clazz))}
|
* shortcut for {@code unwrap(TypeToken.of(clazz))}
|
||||||
|
*
|
||||||
* @see #unwrap(TypeToken)
|
* @see #unwrap(TypeToken)
|
||||||
*/
|
*/
|
||||||
<C extends Closeable> C unwrap(Class<C> clazz) throws IllegalArgumentException;
|
<C extends Closeable> C unwrap(Class<C> clazz) throws IllegalArgumentException;
|
||||||
|
|
Loading…
Reference in New Issue