Index (microBean™ Bean 0.0.19 API)

A B C D E F G H I L N O P Q R S T U
All Classes and Interfaces|All Packages|Constant Field Values|External Specifications|Serialized Form

A

alternate() - Method in record class org.microbean.bean.Bean
alternate() - Method in record class org.microbean.bean.Id: Returns the value of the alternate record component.
alternate() - Method in interface org.microbean.bean.Ranked: Deprecated.

Returns true if this Ranked is to be considered an alternate, which may have an effect on how the return value of the Ranked.rank() method is interpreted in some situations.
alternates() - Method in exception class org.microbean.bean.AmbiguousReductionException: Returns the contextual instances that could not be reduced.
ambiguityReducing(Selectable<C, E>) - Static method in class org.microbean.bean.Selectables: Deprecated, for removal: This API element is subject to removal in a future version.
Please use the Selectables.ambiguityReducing(Selectable, Predicate, ToIntFunction) method instead.
ambiguityReducing(Selectable<C, E>, Predicate<? super E>, ToIntFunction<? super E>) - Static method in class org.microbean.bean.Selectables: Returns a Selectable that reduces any ambiguity in the results returned by another Selectable, considering alternate status and rank.
AmbiguousReductionException - Exception Class in org.microbean.bean: A ReductionException indicating that many contextual instances could not be reduced to one.
AmbiguousReductionException(Object, Collection<?>, String) - Constructor for exception class org.microbean.bean.AmbiguousReductionException: Creates a new AmbiguousReductionException.
assign(Function<? super AttributedType, ?>) - Method in record class org.microbean.bean.Bean
attributes() - Method in record class org.microbean.bean.Id: Returns the value of the attributes record component.
AutoCloseableRegistry - Interface in org.microbean.bean: A reigstry of AutoCloseable instances that itself is AutoCloseable.

B

Bean - Record Class in org.microbean.bean: A (Constable) pairing of an Id with a Factory.
Bean(Id, Factory) - Constructor for record class org.microbean.bean.Bean: Creates a new Bean.
BeanException - Exception Class in org.microbean.bean: A RuntimeException indicating that an error has occurred in code in this package.
BeanException() - Constructor for exception class org.microbean.bean.BeanException: Creates a new BeanException.
BeanException(String) - Constructor for exception class org.microbean.bean.BeanException: Creates a new BeanException.
BeanException(String, Throwable) - Constructor for exception class org.microbean.bean.BeanException: Creates a new BeanException.
BeanException(Throwable) - Constructor for exception class org.microbean.bean.BeanException: Creates a new BeanException.
BeanQualifiersMatcher - Class in org.microbean.bean: A Matcher encapsulating CDI-compatible bean qualifier matching rules.
BeanQualifiersMatcher() - Constructor for class org.microbean.bean.BeanQualifiersMatcher: Creates a new BeanQualifiersMatcher.
Beans - Class in org.microbean.bean: Utility methods for working with Beans.
BeanTypeList - Class in org.microbean.bean: An immutable AbstractList of TypeMirrors that contains only legal bean types, sorted in a specific manner.
BeanTypeMatcher - Class in org.microbean.bean: An AbstractTypeMatcher encapsulating CDI-compatible type matching rules.
BeanTypeMatcher(Domain) - Constructor for class org.microbean.bean.BeanTypeMatcher: Creates a new BeanTypeMatcher.
beanTypes(TypeMirror) - Method in class org.microbean.bean.BeanTypes: Returns a BeanTypeList of legal bean types that the supplied TypeMirror bears.
BeanTypes - Class in org.microbean.bean: A utility for working with bean types.
BeanTypes(Domain) - Constructor for class org.microbean.bean.BeanTypes: Creates a new BeanTypes.

C

cast() - Method in record class org.microbean.bean.Bean: Returns this Bean, forcibly cast appropriately.
CDI Specification, version 4.0, section 2.2.10 - Search tag in org.microbean.bean.BeanTypeList.proxiable(): External Specification
CDI Specification, version 4.1, section 2.2.1 - Search tag in org.microbean.bean.BeanTypes.legalBeanType(TypeMirror): External Specification
CDI Specification, version 4.1, section 3.10 - Search tag in org.microbean.bean.BeanTypes.proxiableBeanType(TypeMirror): External Specification
clearCaches() - Method in class org.microbean.bean.BeanTypes: Clears caches that may be used internally by this BeanTypes.
close() - Method in interface org.microbean.bean.AutoCloseableRegistry: Closes this AutoCloseableRegistry and closes its registrants.
close() - Method in class org.microbean.bean.DefaultAutoCloseableRegistry: Closes this DefaultAutoCloseableRegistry and closes its registrants.
close() - Method in interface org.microbean.bean.Destruction: Closes this Destruction idempotently, normally thereby releasing a contextual instance's dependent objects that have been stored opaquely in this Destruction by some other mechanism at creation time.
close() - Method in class org.microbean.bean.DisposableReference: Calls Reference.enqueue().
closed() - Method in interface org.microbean.bean.AutoCloseableRegistry: Returns true if and only if this AutoCloseableRegistry is closed.
closed() - Method in class org.microbean.bean.DefaultAutoCloseableRegistry: Returns true if and only if this DefaultAutoCloseableRegistry is closed.
closed() - Method in class org.microbean.bean.DisposableReference: Calls refersTo(null) and returns the result.
Constant - Record Class in org.microbean.bean: A Factory that returns its singleton from its Constant.create(Request) method.
Constant(I) - Constructor for record class org.microbean.bean.Constant: Creates a new Constant.
create(Creation) - Method in record class org.microbean.bean.Constant: Invokes the Constant.singleton() method and returns its result.
create(Creation) - Method in interface org.microbean.bean.Factory: Returns a (normally new) contextual instance, which may be null.
creating(I) - Method in interface org.microbean.bean.Creation: Signals that the supplied instance is in the process of being created, typically by an invocation of a Factory's create(Creation) method, and is about to be made available for use.
Creation - Interface in org.microbean.bean: A representation of a Factory's creation activity.
CreationException - Exception Class in org.microbean.bean: A BeanException indicating a problem with creation.
CreationException() - Constructor for exception class org.microbean.bean.CreationException: Creates a new CreationException.
CreationException(String) - Constructor for exception class org.microbean.bean.CreationException: Creates a new CreationException.
CreationException(String, Throwable) - Constructor for exception class org.microbean.bean.CreationException: Creates a new CreationException.
CreationException(Throwable) - Constructor for exception class org.microbean.bean.CreationException: Creates a new CreationException.
criteria() - Method in exception class org.microbean.bean.ReductionException: Returns this ReductionException's criteria object, which may be null.

D

DEFAULT_RANK - Static variable in interface org.microbean.bean.Ranked: Deprecated.

The default rank (0) when returned by an implementation of the Ranked.rank() method.
DefaultAutoCloseableRegistry - Class in org.microbean.bean: A straightforward AutoCloseableRegistry implementation.
DefaultAutoCloseableRegistry() - Constructor for class org.microbean.bean.DefaultAutoCloseableRegistry: Creates a new DefaultAutoCloseableRegistry.
dependencies() - Method in record class org.microbean.bean.Bean
describeConstable() - Method in record class org.microbean.bean.Bean
describeConstable() - Method in class org.microbean.bean.BeanTypeList
describeConstable() - Method in record class org.microbean.bean.Constant
describeConstable() - Method in interface org.microbean.bean.Factory: Returns an Optional containing the nominal descriptor for this instance, if one can be constructed, or an empty Optional if one cannot be constructed.
describeConstable() - Method in record class org.microbean.bean.Id
destroy(I, Destruction) - Method in record class org.microbean.bean.Constant
destroy(I, Destruction) - Method in interface org.microbean.bean.Factory: Destroys the supplied contextual instance.
destroy(Object) - Method in interface org.microbean.bean.ReferencesSelector: Destroys the supplied contextual reference if and only if it meets the conditions for destruction.
destroys() - Method in record class org.microbean.bean.Constant: Returns true if and only if the return value of an invocation of the Constant.singleton() method is AutoCloseable.
destroys() - Method in interface org.microbean.bean.Factory: Returns true if this Factory implementation destroys its created contextual instances in some way, or false if it does not.
Destruction - Interface in org.microbean.bean: An object describing the imminent destruction of a contextual instance by the Factory.destroy(Object, Destruction) method.
DestructionException - Exception Class in org.microbean.bean: A BeanException indicating a problem with destruction.
DestructionException() - Constructor for exception class org.microbean.bean.DestructionException: Creates a new DestructionException.
DestructionException(String) - Constructor for exception class org.microbean.bean.DestructionException: Creates a new DestructionException.
DestructionException(String, Throwable) - Constructor for exception class org.microbean.bean.DestructionException: Creates a new DestructionException.
DestructionException(Throwable) - Constructor for exception class org.microbean.bean.DestructionException: Creates a new DestructionException.
DisposableReference<R> - Class in org.microbean.bean: An AutoCloseable WeakReference that formally disposes of referents after they have been cleared by the Java Virtual Machine during garbage collection.
DisposableReference(R, Consumer<? super R>) - Constructor for class org.microbean.bean.DisposableReference: Creates a new DisposableReference.
dispose() - Method in class org.microbean.bean.DisposableReference: If there has been no prior successful invocation of this method, calls the accept(Object) method on the Consumer representing the disposer supplied at construction time, thus notionally disposing the referent supplied at construction time, and returns true.
disposed() - Method in class org.microbean.bean.DisposableReference: Returns true if and only if there has been a prior successful invocation of DisposableReference.dispose() that returned true.

E

equals(Object) - Method in record class org.microbean.bean.Bean: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.microbean.bean.Constant: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.microbean.bean.Id: Indicates whether some other object is "equal to" this one.

F

factory() - Method in record class org.microbean.bean.Bean: Returns the value of the factory record component.
Factory - Interface in org.microbean.bean: A source of (normally new) contextual instances.

G

get() - Method in interface org.microbean.bean.References: A convenience method that acquires and returns what is presumed, possibly incorrectly, to be the sole contextual reference available from this References.
get(int) - Method in class org.microbean.bean.BeanTypeList

H

hashCode() - Method in record class org.microbean.bean.Bean: Returns a hash code value for this object.
hashCode() - Method in record class org.microbean.bean.Constant: Returns a hash code value for this object.
hashCode() - Method in record class org.microbean.bean.Id: Returns a hash code value for this object.

I

id() - Method in record class org.microbean.bean.Bean: Returns the value of the id record component.
id() - Method in interface org.microbean.bean.Creation: Returns the Id of the Bean whose Factory's Factory.create(Creation) invocation was responsible for the existence of this Creation.
Id - Record Class in org.microbean.bean: An identifier for a Bean.
Id(BeanTypeList, List<Attributes>) - Constructor for record class org.microbean.bean.Id: Creates a new Id that is not an alternate and that therefore has a default rank.
Id(BeanTypeList, List<Attributes>, boolean, int) - Constructor for record class org.microbean.bean.Id: Creates a new Id.
IdMatcher - Class in org.microbean.bean: A Matcher that tests an Id to see if it matches an AttributedType.
IdMatcher(BeanTypeMatcher, BeanQualifiersMatcher) - Constructor for class org.microbean.bean.IdMatcher: Creates a new IdMatcher.
IdMatcher(BeanTypeMatcher, BeanQualifiersMatcher, Matcher<AttributedType, Id>) - Constructor for class org.microbean.bean.IdMatcher: Creates a new IdMatcher.
interfaceIndex() - Method in class org.microbean.bean.BeanTypeList: Returns the index of the first interface type this BeanTypeList contains, or a negative value if it contains no interface types.
isEmpty() - Method in class org.microbean.bean.BeanTypeList

L

legalBeanType(TypeMirror) - Static method in class org.microbean.bean.BeanTypes: Returns true if and only if the supplied TypeMirror is a legal bean type as defined by the CDI specification.

N

newChild() - Method in interface org.microbean.bean.AutoCloseableRegistry: Returns a new AutoCloseableRegistry instance that is not closed, has no registrations yet, and is registered with this AutoCloseableRegistry.
newChild() - Method in class org.microbean.bean.DefaultAutoCloseableRegistry: Returns a new DefaultAutoCloseableRegistry instance that is not closed, has no registrations yet, and is registered with this DefaultAutoCloseableRegistry.
normalize(Collection<? extends Bean<?>>) - Static method in class org.microbean.bean.Beans: Returns an immutable List containing a subset of distinct elements contained in the supplied Collection, sorted in a deliberately unspecified fashion.

O

of(Domain, Collection<? extends TypeMirror>) - Static method in class org.microbean.bean.BeanTypeList: Returns a non-null BeanTypeList suitable for the supplied arguments.
org.microbean.bean - module org.microbean.bean: Provides packages related to implementing beans.
org.microbean.bean - package org.microbean.bean: Provides classes and interfaces related to implementing beans.
outranks(int) - Method in interface org.microbean.bean.Ranked: Deprecated.

Returns true if this Ranked bears a rank that outranks the rank represented by j according to the rules described in the specification for the outranks(int, int) method.
outranks(int, int) - Static method in interface org.microbean.bean.Ranked: Deprecated.

Returns true if and only if a rank represented by i outranks a rank represented by j.
outranks(Ranked) - Method in interface org.microbean.bean.Ranked: Deprecated.

Returns true if this Ranked outranks the supplied Ranked according to the rules described in the specification for the outranks(int, int) method.
outranks(Ranked, Ranked) - Static method in interface org.microbean.bean.Ranked: Deprecated.

Returns true if and only if r0 is non-null and outranks r1.

P

proxiable() - Method in class org.microbean.bean.BeanTypeList: Returns true if and only if this BeanTypeList is proxiable.
proxiableBeanType(TypeMirror) - Static method in class org.microbean.bean.BeanTypes: Returns true if and only if the supplied TypeMirror is a legal, declared, proxiable bean type as defined by the CDI specification.

Q

qualifiers(Collection<? extends Attributes>) - Method in class org.microbean.bean.BeanQualifiersMatcher: Returns an unmodifiable Collection consisting only of those Attributess in the supplied Collection that are deemed to be qualifiers.

R

rank() - Method in record class org.microbean.bean.Bean
rank() - Method in record class org.microbean.bean.Id: Returns the value of the rank record component.
rank() - Method in interface org.microbean.bean.Ranked: Deprecated.

Returns the rank of this Ranked implementation.
Ranked - Interface in org.microbean.bean: Deprecated.
This class is deprecated for future removal.
ReductionException - Exception Class in org.microbean.bean: A BeanException concerning problematic reductions.
ReductionException(Object, String, Throwable) - Constructor for exception class org.microbean.bean.ReductionException: Creates a new ReductionException.
reference(AttributedType) - Method in interface org.microbean.bean.ReferencesSelector: A convenience method that acquires and returns what is presumed, possibly incorrectly, to be the sole contextual reference of the relevant type.
references(AttributedType) - Method in interface org.microbean.bean.ReferencesSelector: Returns a References capable of locating contextual references of the relevant type.
References<R> - Interface in org.microbean.bean: An Iterable providing access to contextual references of a given type, and a ReferencesSelector providing access to a References of a different type.
ReferencesSelector - Interface in org.microbean.bean: A supplier of References objects.
register(AutoCloseable) - Method in interface org.microbean.bean.AutoCloseableRegistry: If this AutoCloseableRegistry is not closed, and if the supplied AutoCloseable has not yet been registered, registers it such that it will be closed when this AutoCloseableRegistry is closed, and returns true.
register(AutoCloseable) - Method in class org.microbean.bean.DefaultAutoCloseableRegistry: If this DefaultAutoCloseableRegistry is not closed, and if the supplied AutoCloseable has not yet been registered, registers it such that it will be closed when this DefaultAutoCloseableRegistry is closed, and returns true.

S

Selectables - Class in org.microbean.bean: Utility methods for working with Selectables.
singleton() - Method in record class org.microbean.bean.Constant: Returns the value of the singleton record component.
singleton() - Method in interface org.microbean.bean.Factory: Returns the sole contextual instance of this Factory's type, if there is one, or null in the very common case that there is not.
size() - Method in class org.microbean.bean.BeanTypeList
size() - Method in interface org.microbean.bean.References: Returns the size of this References.

T

test(Collection<? extends Attributes>, Collection<? extends Attributes>) - Method in class org.microbean.bean.BeanQualifiersMatcher: Returns true if and only if either (a) the collection of qualifiers present in receiverAttributes is empty and either the collection of qualifiers present in payloadAttributes is also empty or contains the default qualifier, or (b) if the collection of qualifiers present in payloadAttributes is empty or the return value of Qualifiers.anyAndDefaultQualifiers() contains all of the qualifiers present in receiverAttributes, or (c) if the collection of qualifiers present in payloadAttributes contains all of the qualifiers present in receiverAttributes.
test(TypeMirror, TypeMirror) - Method in class org.microbean.bean.BeanTypeMatcher: Returns true if and only if the supplied payload argument matches the supplied receiver argument, according to the rules defined by section 2.4.2.1 of the CDI specification.
test(AttributedType, Id) - Method in class org.microbean.bean.IdMatcher: Tests the supplied Id to see if it matches the supplied AttributedType and returns the result.
toString() - Method in record class org.microbean.bean.Bean: Returns a string representation of this record class.
toString() - Method in record class org.microbean.bean.Constant: Returns a string representation of this record class.
toString() - Method in record class org.microbean.bean.Id: Returns a string representation of this record class.
toString() - Method in exception class org.microbean.bean.ReductionException: Returns a String reprsentation of this ReductionException.
types() - Method in record class org.microbean.bean.Id: Returns the value of the types record component.
typesafeReducing(Collection<? extends Bean<?>>, Matcher<? super AttributedType, ? super Id>) - Static method in class org.microbean.bean.Selectables: Normalizes the supplied Collection of Beans and returns a Selectable for it and the supplied Matcher.

U

UnsatisfiedReductionException - Exception Class in org.microbean.bean: A ReductionException indicating that a reduction did not occur because there were no elements to reduce.
UnsatisfiedReductionException(Object, String, Throwable) - Constructor for exception class org.microbean.bean.UnsatisfiedReductionException: Creates a new UnsatisfiedReductionException.

A B C D E F G H I L N O P Q R S T U
All Classes and Interfaces|All Packages|Constant Field Values|External Specifications|Serialized Form