aboutsummaryrefslogtreecommitdiffstats
path: root/docs/progGuideDB/idioms.adoc
blob: e27395a481d277b74063e7d4181071c4454d6dcc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
== Idioms

[[idioms-intro]]
=== Introduction

This chapter consists of very short snippets of AspectJ code, typically
pointcuts, that are particularly evocative or useful. This section is a
work in progress.

Here's an example of how to enfore a rule that code in the `java.sql`
package can only be used from one particular package in your system.
This doesn't require any access to code in the `java.sql` package.

[source, java]
....
/* Any call to methods or constructors in java.sql */
pointcut restrictedCall():
  call(* java.sql.*.*(..)) || call(java.sql.*.new(..));

/* Any code in my system not in the sqlAccess package */
pointcut illegalSource():
  within(com.foo..*) && !within(com.foo.sqlAccess.*);

declare error: restrictedCall() && illegalSource():
  "java.sql package can only be accessed from com.foo.sqlAccess";
....

Any call to an instance of a subtype of `AbstractFacade` whose class is
not exactly equal to `AbstractFacade`:

[source, java]
....
pointcut nonAbstract(AbstractFacade af):
  call(* *(..))
  && target(af)
  && !if(af.getClass() == AbstractFacade.class);
....

If `AbstractFacade` is an abstract class or an interface, then every
instance must be of a subtype and you can replace this with:

[source, java]
....
pointcut nonAbstract(AbstractFacade af):
  call(* *(..))
  && target(af);
....

Any call to a method which is defined by a subtype of `AbstractFacade`,
but which isn't defined by the type `AbstractFacade` itself:

[source, java]
....
pointcut callToUndefinedMethod():
   call(* AbstractFacade+.*(..))
   && !call(* AbstractFacade.*(..));
....

The execution of a method that is defined in the source code for a type
that is a subtype of `AbstractFacade` but not in `AbstractFacade` itself:

[source, java]
....
pointcut executionOfUndefinedMethod():
  execution(* *(..))
  && within(AbstractFacade+)
  && !within(AbstractFacade)
....