A C D E G H I N O P R S T U V
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- addComponentDependency(Class<D>, String) - Method in class org.xwiki.component.descriptor.DefaultComponentDescriptor
- addComponentDependency(ComponentDependency<?>) - Method in class org.xwiki.component.descriptor.DefaultComponentDescriptor
C
- checkAllowed(Collection<String>, String) - Method in interface org.xwiki.component.namespace.NamespaceValidator
- Component - Annotation Type in org.xwiki.component.annotation
-
Defines a component implementation.
- ComponentDependency<T> - Interface in org.xwiki.component.descriptor
-
Represents a component dependency.
- ComponentDescriptor<T> - Interface in org.xwiki.component.descriptor
-
Represent a component.
- ComponentEventManager - Interface in org.xwiki.component.manager
-
Manages Component Events (when a component instance is created for example).
- ComponentInstantiationStrategy - Enum in org.xwiki.component.descriptor
-
Lists valid instantiation strategy types (singleton, per lookup).
- ComponentLifecycleException - Exception in org.xwiki.component.manager
-
Raised during component's unregistration if an error happens during the end lifecycle execution.
- ComponentLifecycleException(String) - Constructor for exception org.xwiki.component.manager.ComponentLifecycleException
- ComponentLifecycleException(String, Throwable) - Constructor for exception org.xwiki.component.manager.ComponentLifecycleException
- ComponentLookupException - Exception in org.xwiki.component.manager
-
Raised during component lookup when an error happens.
- ComponentLookupException(String) - Constructor for exception org.xwiki.component.manager.ComponentLookupException
- ComponentLookupException(String, Throwable) - Constructor for exception org.xwiki.component.manager.ComponentLookupException
- ComponentManager - Interface in org.xwiki.component.manager
-
Provide way to access and modify components repository.
- ComponentManagerInitializer - Interface in org.xwiki.component.manager
-
Called at
ComponentManager
initialization to be able to apply modification to the ComponentManager and its components before it's really used (send events, etc.). - ComponentRepositoryException - Exception in org.xwiki.component.manager
- ComponentRepositoryException(String) - Constructor for exception org.xwiki.component.manager.ComponentRepositoryException
- ComponentRepositoryException(String, Throwable) - Constructor for exception org.xwiki.component.manager.ComponentRepositoryException
- ComponentRole<T> - Interface in org.xwiki.component.descriptor
-
Identify a unique component.
- ComponentRole - Annotation Type in org.xwiki.component.annotation
-
Deprecated.since 4.0M1 use
Role
instead
D
- DEFAULT_PRIORITY - Static variable in annotation type org.xwiki.component.annotation.DisposePriority
-
Default dispose priority.
- DefaultComponentDependency<T> - Class in org.xwiki.component.descriptor
-
Default implementation of
ComponentDependency
. - DefaultComponentDependency() - Constructor for class org.xwiki.component.descriptor.DefaultComponentDependency
-
Default constructor.
- DefaultComponentDependency(ComponentDependency<T>) - Constructor for class org.xwiki.component.descriptor.DefaultComponentDependency
-
Create a new DefaultComponentDependency by cloning the provided
ComponentDependency
. - DefaultComponentDescriptor<T> - Class in org.xwiki.component.descriptor
-
Default implementation of
ComponentDescriptor
. - DefaultComponentDescriptor() - Constructor for class org.xwiki.component.descriptor.DefaultComponentDescriptor
-
Default constructor.
- DefaultComponentDescriptor(ComponentDescriptor<T>) - Constructor for class org.xwiki.component.descriptor.DefaultComponentDescriptor
-
Creating a new
DefaultComponentDescriptor
by cloning the providedComponentDescriptor
. - DefaultComponentRole<T> - Class in org.xwiki.component.descriptor
- DefaultComponentRole() - Constructor for class org.xwiki.component.descriptor.DefaultComponentRole
-
Default constructor.
- DefaultComponentRole(Type, String) - Constructor for class org.xwiki.component.descriptor.DefaultComponentRole
- DefaultComponentRole(ComponentRole<T>) - Constructor for class org.xwiki.component.descriptor.DefaultComponentRole
-
Create a new
DefaultComponentRole
by cloning the providedComponentRole
. - DefaultParameterizedType - Class in org.xwiki.component.util
-
Basic implementation of
ParameterizedType
. - DefaultParameterizedType(ParameterizedType) - Constructor for class org.xwiki.component.util.DefaultParameterizedType
- DefaultParameterizedType(Type, Class<?>, Type...) - Constructor for class org.xwiki.component.util.DefaultParameterizedType
- Disposable - Interface in org.xwiki.component.phase
-
If a singleton component could be destroyed and replaced in the component manager, it should implement this interface to properly clean up its resources.
- dispose() - Method in interface org.xwiki.component.phase.Disposable
-
Method called by the Component Manager when a singleton component is unregistered and should be destroyed.
- DisposePriority - Annotation Type in org.xwiki.component.annotation
-
Helps controlling the order in which Components are disposed upon XWiki's shutdown.
E
- equals(Object) - Method in class org.xwiki.component.descriptor.DefaultComponentDependency
- equals(Object) - Method in class org.xwiki.component.descriptor.DefaultComponentDescriptor
- equals(Object) - Method in class org.xwiki.component.descriptor.DefaultComponentRole
- equals(Object) - Method in class org.xwiki.component.namespace.Namespace
- equals(Object) - Method in class org.xwiki.component.util.DefaultParameterizedType
- equals(Object, Object) - Static method in class org.xwiki.component.util.ObjectUtils
-
Deprecated.use
Objects.equals(Object, Object)
instead - execute(Namespace, Callable<V>) - Method in interface org.xwiki.component.namespace.NamespaceContextExecutor
-
Execute the passed
Callable
in the context of the specified namespace.
G
- getActualTypeArguments() - Method in class org.xwiki.component.util.DefaultParameterizedType
- getAllFields(Class<?>) - Static method in class org.xwiki.component.util.ReflectionUtils
- getAllMethods(Class<?>) - Static method in class org.xwiki.component.util.ReflectionUtils
-
Find all methods (public, private, package private, protected) in the current class and in all its superclasses.
- getComponentDependencies() - Method in interface org.xwiki.component.descriptor.ComponentDescriptor
- getComponentDependencies() - Method in class org.xwiki.component.descriptor.DefaultComponentDescriptor
- getComponentDescriptor(Type, String) - Method in interface org.xwiki.component.manager.ComponentManager
- getComponentDescriptorList(Class<T>) - Method in interface org.xwiki.component.manager.ComponentManager
-
Deprecated.since 4.0M1 use
ComponentManager.getComponentDescriptorList(Type)
instead - getComponentDescriptorList(Type) - Method in interface org.xwiki.component.manager.ComponentManager
- getComponentEventManager() - Method in interface org.xwiki.component.manager.ComponentManager
- getDirectAnnotation(Class<T>, AnnotatedElement) - Static method in class org.xwiki.component.util.ReflectionUtils
-
Get the first found annotation with the provided class directly assigned to the provided
AnnotatedElement
. - getDirectTypes(Type) - Static method in class org.xwiki.component.util.ReflectionUtils
- getField(Class<?>, String) - Static method in class org.xwiki.component.util.ReflectionUtils
- getGenericClassType(Class, Class) - Static method in class org.xwiki.component.util.ReflectionUtils
-
Extract the real Type from the passed class.
- getHints() - Method in interface org.xwiki.component.descriptor.ComponentDependency
- getHints() - Method in class org.xwiki.component.descriptor.DefaultComponentDependency
- getImplementation() - Method in interface org.xwiki.component.descriptor.ComponentDescriptor
- getImplementation() - Method in class org.xwiki.component.descriptor.DefaultComponentDescriptor
- getInstance(Type) - Method in interface org.xwiki.component.manager.ComponentManager
-
Find a component instance that implements that passed type.
- getInstance(Type, String) - Method in interface org.xwiki.component.manager.ComponentManager
-
Find a component instance that implements that passed interface class.
- getInstanceList(Type) - Method in interface org.xwiki.component.manager.ComponentManager
-
Find all the components implementing the provided role.
- getInstanceMap(Type) - Method in interface org.xwiki.component.manager.ComponentManager
-
Find all the components implementing the provided role and organize then in a
Map
with role hint as key. - getInstantiationStrategy() - Method in interface org.xwiki.component.descriptor.ComponentDescriptor
- getInstantiationStrategy() - Method in class org.xwiki.component.descriptor.DefaultComponentDescriptor
- getLastFieldGenericArgument(Field) - Static method in class org.xwiki.component.util.ReflectionUtils
-
Extract the last generic type from the passed field.
- getLastGenericClassType(Class, Class) - Static method in class org.xwiki.component.util.ReflectionUtils
-
Extract the last generic type from the passed class.
- getLastGenericFieldType(Field) - Static method in class org.xwiki.component.util.ReflectionUtils
-
Extract the last generic type from the passed field.
- getLastTypeGenericArgument(Type) - Static method in class org.xwiki.component.util.ReflectionUtils
-
Extract the last generic type from the passed Type.
- getMappingType() - Method in interface org.xwiki.component.descriptor.ComponentDependency
-
Deprecated.since 4.0M1 use
ComponentRole.getRoleType()
instead - getMappingType() - Method in class org.xwiki.component.descriptor.DefaultComponentDependency
-
Deprecated.
- getMethodParameterAnnotations(Method, int, Class<A>) - Static method in class org.xwiki.component.util.ReflectionMethodUtils
-
Get
Annotation
s of the provided class associated to the the provided method parameter. - getMethodParameterAnnotations(Method, int, Class<A>, boolean) - Static method in class org.xwiki.component.util.ReflectionMethodUtils
-
Get
Annotation
s of the provided class associated to the the provided method parameter. - getName() - Method in interface org.xwiki.component.descriptor.ComponentDependency
- getName() - Method in class org.xwiki.component.descriptor.DefaultComponentDependency
- getNamespace() - Method in interface org.xwiki.component.manager.NamespacedComponentManager
- getOwnerType() - Method in class org.xwiki.component.util.DefaultParameterizedType
- getParent() - Method in interface org.xwiki.component.manager.ComponentManager
- getPrefix(String) - Static method in class org.xwiki.component.namespace.NamespaceUtils
-
Extract prefix of the id used to find custom factory.
- getRawType() - Method in class org.xwiki.component.util.DefaultParameterizedType
- getRole() - Method in interface org.xwiki.component.descriptor.ComponentRole
-
Deprecated.since 4.0M1 use
ComponentRole.getRoleType()
instead - getRole() - Method in class org.xwiki.component.descriptor.DefaultComponentDependency
- getRole() - Method in class org.xwiki.component.descriptor.DefaultComponentRole
-
Deprecated.
- getRoleHint() - Method in interface org.xwiki.component.descriptor.ComponentRole
- getRoleHint() - Method in class org.xwiki.component.descriptor.DefaultComponentRole
- getRoleType() - Method in interface org.xwiki.component.descriptor.ComponentRole
- getRoleType() - Method in class org.xwiki.component.descriptor.DefaultComponentRole
- getType() - Method in class org.xwiki.component.namespace.Namespace
- getTypeClass(Type) - Static method in class org.xwiki.component.util.ReflectionUtils
-
Extract the main class from the passed
Type
. - getValue() - Method in class org.xwiki.component.namespace.Namespace
H
- hasCode(Object) - Static method in class org.xwiki.component.util.ObjectUtils
-
Deprecated.use
Objects.hashCode(Object)
instead - hasComponent(Type) - Method in interface org.xwiki.component.manager.ComponentManager
- hasComponent(Type, String) - Method in interface org.xwiki.component.manager.ComponentManager
- hashCode() - Method in class org.xwiki.component.descriptor.DefaultComponentDependency
- hashCode() - Method in class org.xwiki.component.descriptor.DefaultComponentDescriptor
- hashCode() - Method in class org.xwiki.component.descriptor.DefaultComponentRole
- hashCode() - Method in class org.xwiki.component.namespace.Namespace
- hashCode() - Method in class org.xwiki.component.util.DefaultParameterizedType
- hints() - Method in annotation type org.xwiki.component.annotation.Component
-
Sometimes you want to register the component several times with different hints.
I
- Initializable - Interface in org.xwiki.component.phase
- InitializationException - Exception in org.xwiki.component.phase
-
Raised when component initialization failed.
- InitializationException(String) - Constructor for exception org.xwiki.component.phase.InitializationException
- InitializationException(String, Throwable) - Constructor for exception org.xwiki.component.phase.InitializationException
- initialize() - Method in interface org.xwiki.component.phase.Initializable
-
Method called by the Component Manager when the component is created for the first time (i.e.
- initialize(ComponentManager) - Method in interface org.xwiki.component.manager.ComponentManagerInitializer
-
Apply modifications on ComponentManager at init (register new components, disables others, ...).
- InstantiationStrategy - Annotation Type in org.xwiki.component.annotation
-
Defines the instantiation strategy for this component (Singleton, per lookup).
- isAllowed(Collection<String>, String) - Method in interface org.xwiki.component.namespace.NamespaceValidator
N
- Namespace - Class in org.xwiki.component.namespace
-
A namespace.
- Namespace(String, String) - Constructor for class org.xwiki.component.namespace.Namespace
- NamespaceContextExecutor - Interface in org.xwiki.component.namespace
-
Allow executing some code in the context of the specified namespace.
- NamespacedComponentManager - Interface in org.xwiki.component.manager
-
Add namespace information to
ComponentManager
. - NamespaceNotAllowedException - Exception in org.xwiki.component.namespace
-
Exception used when a namespace is not matched in a list of allowed namespaces.
- NamespaceNotAllowedException(String) - Constructor for exception org.xwiki.component.namespace.NamespaceNotAllowedException
- NamespaceNotAllowedException(String, Throwable) - Constructor for exception org.xwiki.component.namespace.NamespaceNotAllowedException
- NamespaceUtils - Class in org.xwiki.component.namespace
-
Various namespaces utilities.
- NamespaceValidator - Interface in org.xwiki.component.namespace
-
Validate a namespace against list of allowed namespaces.
- notifyComponentRegistered(ComponentDescriptor<?>) - Method in interface org.xwiki.component.manager.ComponentEventManager
-
Deprecated.since 3.3 use
ComponentEventManager.notifyComponentRegistered(ComponentDescriptor, ComponentManager)
instead - notifyComponentRegistered(ComponentDescriptor<?>, ComponentManager) - Method in interface org.xwiki.component.manager.ComponentEventManager
-
Notify all listeners that a component with the passed descriptor has been registered.
- notifyComponentUnregistered(ComponentDescriptor<?>) - Method in interface org.xwiki.component.manager.ComponentEventManager
-
Deprecated.since 3.3 use
ComponentEventManager.notifyComponentUnregistered(ComponentDescriptor, ComponentManager)
instead - notifyComponentUnregistered(ComponentDescriptor<?>, ComponentManager) - Method in interface org.xwiki.component.manager.ComponentEventManager
-
Notify all listeners that a component with the passed descriptor has been unregistered.
O
- ObjectUtils - Class in org.xwiki.component.util
-
Various Object utilities.
- org.xwiki.component.annotation - package org.xwiki.component.annotation
- org.xwiki.component.descriptor - package org.xwiki.component.descriptor
- org.xwiki.component.manager - package org.xwiki.component.manager
- org.xwiki.component.namespace - package org.xwiki.component.namespace
- org.xwiki.component.phase - package org.xwiki.component.phase
- org.xwiki.component.util - package org.xwiki.component.util
P
- PER_LOOKUP - org.xwiki.component.descriptor.ComponentInstantiationStrategy
-
A new component implementation instance is created at a each lookup.
- ProviderLookupException - Exception in org.xwiki.component.manager
-
Raised during provider lookup when an error happens.
- ProviderLookupException(String) - Constructor for exception org.xwiki.component.manager.ProviderLookupException
- ProviderLookupException(String, Throwable) - Constructor for exception org.xwiki.component.manager.ProviderLookupException
R
- ReflectionMethodUtils - Class in org.xwiki.component.util
-
Various Reflection tools related to
Method
s. - ReflectionUtils - Class in org.xwiki.component.util
-
Various Reflection utilities.
- registerComponent(ComponentDescriptor<T>) - Method in interface org.xwiki.component.manager.ComponentManager
-
Add a component in the component repository dynamically.
- registerComponent(ComponentDescriptor<T>, T) - Method in interface org.xwiki.component.manager.ComponentManager
-
Add a component in the component repository dynamically.
- release(Object) - Method in interface org.xwiki.component.manager.ComponentManager
-
Release the provided singleton instance but don't unregister the component descriptor.
- resolveSuperArguments(Type[], Class, Type[]) - Static method in class org.xwiki.component.util.ReflectionUtils
- resolveSuperArguments(Type[], Type) - Static method in class org.xwiki.component.util.ReflectionUtils
- resolveType(Type, Type) - Static method in class org.xwiki.component.util.ReflectionUtils
-
Find and replace the generic parameters with the real types.
- resolveType(Type, Map<TypeVariable, Type>) - Static method in class org.xwiki.component.util.ReflectionUtils
- Role - Annotation Type in org.xwiki.component.annotation
-
Marks a class as defining a component role.
- roles() - Method in annotation type org.xwiki.component.annotation.Component
-
When specified forces the component to be registered as many times as there are roles specified.
- ROOT - Static variable in class org.xwiki.component.namespace.Namespace
-
Root namespace.
S
- serialize() - Method in class org.xwiki.component.namespace.Namespace
- serializeType(Type) - Static method in class org.xwiki.component.util.ReflectionUtils
-
Serialize a type in a String using a standard definition.
- setComponentEventManager(ComponentEventManager) - Method in interface org.xwiki.component.manager.ComponentManager
- setFieldValue(Object, String, Object) - Static method in class org.xwiki.component.util.ReflectionUtils
-
Sets a value to a field using reflection even if the field is private.
- setHints(String[]) - Method in class org.xwiki.component.descriptor.DefaultComponentDependency
- setImplementation(Class<? extends T>) - Method in class org.xwiki.component.descriptor.DefaultComponentDescriptor
- setInstantiationStrategy(ComponentInstantiationStrategy) - Method in class org.xwiki.component.descriptor.DefaultComponentDescriptor
- setMappingType(Class<?>) - Method in class org.xwiki.component.descriptor.DefaultComponentDependency
-
Deprecated.since 4.0M1 use
DefaultComponentRole.setRoleType(java.lang.reflect.Type)
instead - setName(String) - Method in class org.xwiki.component.descriptor.DefaultComponentDependency
- setParent(ComponentManager) - Method in interface org.xwiki.component.manager.ComponentManager
- setRole(Class<T>) - Method in class org.xwiki.component.descriptor.DefaultComponentDependency
- setRole(Class<T>) - Method in class org.xwiki.component.descriptor.DefaultComponentRole
-
Deprecated.since 4.0M1 use
DefaultComponentRole.setRoleType(Type)
instead - setRoleHint(String) - Method in class org.xwiki.component.descriptor.DefaultComponentRole
- setRoleType(Type) - Method in class org.xwiki.component.descriptor.DefaultComponentRole
- SINGLETON - org.xwiki.component.descriptor.ComponentInstantiationStrategy
-
The same component implementation instance is returned for all lookups.
- staticRegistration() - Method in annotation type org.xwiki.component.annotation.Component
T
- toNamespace(String) - Static method in class org.xwiki.component.namespace.NamespaceUtils
- toString() - Method in class org.xwiki.component.descriptor.DefaultComponentDescriptor
- toString() - Method in class org.xwiki.component.descriptor.DefaultComponentRole
- toString() - Method in class org.xwiki.component.namespace.Namespace
- toString() - Method in class org.xwiki.component.util.DefaultParameterizedType
U
- unregisterComponent(Type, String) - Method in interface org.xwiki.component.manager.ComponentManager
-
Remove a component from the component repository dynamically.
- unregisterComponent(ComponentDescriptor<?>) - Method in interface org.xwiki.component.manager.ComponentManager
-
Remove a component from the component repository dynamically.
- unserializeType(String, ClassLoader) - Static method in class org.xwiki.component.util.ReflectionUtils
-
Retrieve a
Type
object from it's serialized form.
V
- value() - Method in annotation type org.xwiki.component.annotation.Component
-
Deprecated.since 3.1M1 use the
@Named
annotation instead - value() - Method in annotation type org.xwiki.component.annotation.DisposePriority
- value() - Method in annotation type org.xwiki.component.annotation.InstantiationStrategy
- valueOf(String) - Static method in enum org.xwiki.component.descriptor.ComponentInstantiationStrategy
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.xwiki.component.descriptor.ComponentInstantiationStrategy
-
Returns an array containing the constants of this enum type, in the order they are declared.
All Classes All Packages