diff --git a/src/main/java/org/apache/sling/event/jobs/Job.java b/src/main/java/org/apache/sling/event/jobs/Job.java index a6065b9..250f8bb 100644 --- a/src/main/java/org/apache/sling/event/jobs/Job.java +++ b/src/main/java/org/apache/sling/event/jobs/Job.java @@ -25,10 +25,14 @@ /** - * A job + * A job encapsulates a task processed by a job consumer. The job may already be finished at the time a Job object is created. + * It exposes metadata in form of properties. + * A job is immutable, meaning that once created the properties/state of the job will not change. + * (In the edge case of the job being processed on the same instance some properties of the job instance might be updated + * but you should not rely on it). + *

* - * - * Property Types + *

Property Types

* * In general all scalar types and all serializable classes are supported as * property types. However, in order for deseralizing classes these must be @@ -41,7 +45,7 @@ * for this behavior as it only supports long but neither integer nor short. * Therefore if you are dealing with numbers, use the {@link #getProperty(String, Class)} * method to get the correct type instead of directly casting it. - * + * * @since 1.2 */ @ProviderType