mybatis source parse

Author: Doing-code

source/mybatis-3-master/src/main/java/org/apache/ibatis/annotations/Arg.java

@@ -0,0 +1,108 @@
+/*
+ *    Copyright 2009-2024 the original author or authors.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+package org.apache.ibatis.annotations;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.apache.ibatis.type.JdbcType;
+import org.apache.ibatis.type.TypeHandler;
+import org.apache.ibatis.type.UnknownTypeHandler;
+
+/**
+ * The annotation that specify a mapping definition for the constructor argument.
+ *
+ * @see ConstructorArgs
+ *
+ * @author Clinton Begin
+ */
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.METHOD)
+@Repeatable(ConstructorArgs.class)
+public @interface Arg {
+
+  /**
+   * Returns whether id column or not.
+   *
+   * @return {@code true} if id column; {@code false} if otherwise
+   */
+  boolean id() default false;
+
+  /**
+   * Return the column name(or column label) to map to this argument.
+   *
+   * @return the column name(or column label)
+   */
+  String column() default "";
+
+  /**
+   * Return the java type for this argument.
+   *
+   * @return the java type
+   */
+  Class<?> javaType() default void.class;
+
+  /**
+   * Return the jdbc type for column that map to this argument.
+   *
+   * @return the jdbc type
+   */
+  JdbcType jdbcType() default JdbcType.UNDEFINED;
+
+  /**
+   * Returns the {@link TypeHandler} type for retrieving a column value from result set.
+   *
+   * @return the {@link TypeHandler} type
+   */
+  Class<? extends TypeHandler> typeHandler() default UnknownTypeHandler.class;
+
+  /**
+   * Return the statement id for retrieving a object that map to this argument.
+   *
+   * @return the statement id
+   */
+  String select() default "";
+
+  /**
+   * Returns the result map id for mapping to a object that map to this argument.
+   *
+   * @return the result map id
+   */
+  String resultMap() default "";
+
+  /**
+   * Returns the parameter name for applying this mapping.
+   *
+   * @return the parameter name
+   *
+   * @since 3.4.3
+   */
+  String name() default "";
+
+  /**
+   * Returns the column prefix that use when applying {@link #resultMap()}.
+   *
+   * @return the column prefix
+   *
+   * @since 3.5.0
+   */
+  String columnPrefix() default "";
+}

source/mybatis-3-master/src/main/java/org/apache/ibatis/annotations/AutomapConstructor.java

@@ -0,0 +1,56 @@
+/*
+ *    Copyright 2009-2024 the original author or authors.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+package org.apache.ibatis.annotations;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * The marker annotation that indicate a constructor for automatic mapping.
+ * <p>
+ * <b>How to use:</b>
+ *
+ * <pre>
+ * public class User {
+ *
+ *   private int id;
+ *   private String name;
+ *
+ *   public User(int id) {
+ *     this.id = id;
+ *   }
+ *
+ *   &#064;AutomapConstructor
+ *   public User(int id, String name) {
+ *     this.id = id;
+ *     this.name = name;
+ *   }
+ *   // ...
+ * }
+ * </pre>
+ *
+ * @author Tim Chen
+ *
+ * @since 3.4.3
+ */
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.CONSTRUCTOR })
+public @interface AutomapConstructor {
+}

source/mybatis-3-master/src/main/java/org/apache/ibatis/annotations/CacheNamespace.java

@@ -0,0 +1,105 @@
+/*
+ *    Copyright 2009-2024 the original author or authors.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+package org.apache.ibatis.annotations;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.apache.ibatis.cache.Cache;
+import org.apache.ibatis.cache.decorators.LruCache;
+import org.apache.ibatis.cache.impl.PerpetualCache;
+
+// @formatter:off
+/**
+ * The annotation that specify to use cache on namespace(e.g. mapper interface).
+ * <p>
+ * <b>How to use:</b>
+ *
+ * <pre>
+ * &#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>
+ *
+ * @author Clinton Begin
+ * @author Kazuki Shimizu
+ */
+// @formatter:on
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+public @interface CacheNamespace {
+
+  /**
+   * Returns the cache implementation type to use.
+   *
+   * @return the cache implementation type
+   */
+  Class<? extends Cache> implementation() default PerpetualCache.class;
+
+  /**
+   * Returns the cache evicting implementation type to use.
+   *
+   * @return the cache evicting implementation type
+   */
+  Class<? extends Cache> eviction() default LruCache.class;
+
+  /**
+   * Returns the flush interval.
+   *
+   * @return the flush interval
+   */
+  long flushInterval() default 0;
+
+  /**
+   * Return the cache size.
+   *
+   * @return the cache size
+   */
+  int size() default 1024;
+
+  /**
+   * Returns whether use read/write cache.
+   *
+   * @return {@code true} if use read/write cache; {@code false} if otherwise
+   */
+  boolean readWrite() default true;
+
+  /**
+   * Returns whether block the cache at request time or not.
+   *
+   * @return {@code true} if block the cache; {@code false} if otherwise
+   */
+  boolean blocking() default false;
+
+  /**
+   * Returns property values for a implementation object.
+   *
+   * @return property values
+   *
+   * @since 3.4.2
+   */
+  Property[] properties() default {};
+
+}

source/mybatis-3-master/src/main/java/org/apache/ibatis/annotations/CacheNamespaceRef.java

@@ -0,0 +1,61 @@
+/*
+ *    Copyright 2009-2024 the original author or authors.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+package org.apache.ibatis.annotations;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * The annotation that reference a cache.
+ * <p>
+ * If you use this annotation, should be specified either {@link #value()} or {@link #name()} attribute.
+ * <p>
+ * <b>How to use:</b>
+ *
+ * <pre>
+ * &#064;CacheNamespaceRef(UserMapper.class)
+ * public interface AdminUserMapper {
+ *   // ...
+ * }
+ * </pre>
+ *
+ * @author Clinton Begin
+ * @author Kazuki Shimizu
+ */
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+public @interface CacheNamespaceRef {
+
+  /**
+   * Returns the namespace type to reference a cache (the namespace name become a FQCN of specified type).
+   *
+   * @return the namespace type to reference a cache
+   */
+  Class<?> value() default void.class;
+
+  /**
+   * Returns the namespace name to reference a cache.
+   *
+   * @return the namespace name
+   *
+   * @since 3.4.2
+   */
+  String name() default "";
+}