Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions src/main/java/org/apache/ibatis/annotations/CacheNamespace.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,16 @@
* <p>
* <b>How to use:</b>
*
* <pre>{@code
* @CacheNamespace(implementation = CustomCache.class, properties = {
* &#064;Property(name = "host", value = "${mybatis.cache.host}"),
* &#064;Property(name = "port", value = "${mybatis.cache.port}"), &#064;Property(name = "name", value = "usersCache") })
* <pre>
* <code>&#064;CacheNamespace(implementation = CustomCache.class, properties = {
* &#064;Property(name = "host", value = "${mybatis.cache.host}"),
* &#064;Property(name = "port", value = "${mybatis.cache.port}"),
* &#064;Property(name = "name", value = "usersCache") })
* public interface UserMapper {
* // ...
* }
* }</pre>
* </code>
* </pre>
*
* @author Clinton Begin
* @author Kazuki Shimizu
Expand Down
13 changes: 7 additions & 6 deletions src/main/java/org/apache/ibatis/annotations/ConstructorArgs.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,16 @@
* <p>
* <b>How to use:</b>
*
* <pre>{@code
* public interface UserMapper {
* @ConstructorArgs({ &#064;Arg(column = "id", javaType = int.class, id = true),
* &#064;Arg(column = "name", javaType = String.class),
* &#064;Arg(javaType = UserEmail.class, select = "selectUserEmailById", column = "id") })
* <pre>
* <code>public interface UserMapper {
* &#064;ConstructorArgs({ &#064;Arg(column = "id", javaType = int.class, id = true),
* &#064;Arg(column = "name", javaType = String.class),
* &#064;Arg(javaType = UserEmail.class, select = "selectUserEmailById", column = "id") })
* &#064;Select("SELECT id, name FROM users WHERE id = #{id}")
* User selectById(int id);
* }
* }</pre>
* </code>
* </pre>
*
* @author Clinton Begin
*/
Expand Down
20 changes: 11 additions & 9 deletions src/main/java/org/apache/ibatis/annotations/Select.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,23 +29,25 @@
* <ul>
* <li>Simple:
*
* <pre>{@code
* public interface UserMapper {
* @Select("SELECT id, name FROM users WHERE id = #{id}")
* <pre>
* <code>public interface UserMapper {
* &#064;Select("SELECT id, name FROM users WHERE id = #{id}")
* User selectById(int id);
* }
* }</pre>
* </code>
* </pre>
*
* </li>
* <li>Dynamic SQL:
*
* <pre>{@code
* public interface UserMapper {
* @Select({ "<script>", "select * from users", "where name = #{name}",
* "<if test=\"age != null\"> age = #{age} </if>", "</script>" })
* <pre>
* <code>public interface UserMapper {
* &#064;Select({ "&lt;script&gt;", "select * from users", "where name = #{name}",
* "&lt;if test=\"age != null\"&gt; age = #{age} &lt;/if&gt;", "&lt;/script&gt;" })
* User select(@NotNull String name, @Nullable Integer age);
* }
* }</pre>
* </code>
* </pre>
*
* </li>
* </ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,17 @@
* <p>
* <b>How to use:</b>
*
* <pre>{@code
* public interface UserMapper {
* <pre>
* <code>public interface UserMapper {
* &#064;Select("SELECT id, name, type FROM users ORDER BY id")
* &#064;TypeDiscriminator(column = "type", javaType = String.class, cases = {
* &#064;Case(value = "1", type = PremiumUser.class), &#064;Case(value = "2", type = GeneralUser.class),
* &#064;Case(value = "3", type = TemporaryUser.class) })
* &#064;Case(value = "1", type = PremiumUser.class),
* &#064;Case(value = "2", type = GeneralUser.class),
* &#064;Case(value = "3", type = TemporaryUser.class) })
* List&lt;User&gt; selectAll();
* }
* }</pre>
* </code>
* </pre>
*
* @author Clinton Begin
*/
Expand Down
7 changes: 4 additions & 3 deletions src/main/java/org/apache/ibatis/plugin/Intercepts.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
* <p>
* <b>How to use:</b>
*
* <pre>{@code
* @Intercepts({ &#064;Signature(type = Executor.class, method = "update", args = { MappedStatement.class, Object.class }) })
* <pre>
* <code>&#064;Intercepts({ &#064;Signature(type = Executor.class, method = "update", args = { MappedStatement.class, Object.class }) })
* public class ExamplePlugin implements Interceptor {
* &#064;Override
* public Object intercept(Invocation invocation) throws Throwable {
Expand All @@ -37,7 +37,8 @@
* return returnObject;
* }
* }
* }</pre>
* </code>
* </pre>
*
* @author Clinton Begin
*/
Expand Down