java doc added

Author: vcharmcaster

hibernate-orm/core/Caching/src/main/java/org/hibernate/brmeyer/demo/AbstractCachingDemo.java

@@ -29,12 +29,18 @@
 import org.hibernate.cfg.Configuration;
 
 /**
+ * The Class AbstractCachingDemo.
+ *
  * @author Brett Meyer
  */
 public class AbstractCachingDemo {
 
+	/** The session factory. */
 	protected final SessionFactory sessionFactory;
 
+	/**
+	 * Instantiates a new abstract caching demo.
+	 */
 	protected AbstractCachingDemo() {
 		final Configuration configuration = new Configuration();
 		configuration.addAnnotatedClass( Project.class );
@@ -44,10 +50,20 @@ protected AbstractCachingDemo() {
 				new StandardServiceRegistryBuilder().build() );
 	}
 
+	/**
+	 * Open session.
+	 *
+	 * @return the session
+	 */
 	protected Session openSession() {
 		return sessionFactory.openSession();
 	}
 
+	/**
+	 * Persist data.
+	 *
+	 * @return the long
+	 */
 	public long persistData() {
 		final Project project = new Project();
 		project.setName( "Foo Project" );

hibernate-orm/core/Caching/src/main/java/org/hibernate/brmeyer/demo/QueryCachingDemo.java

@@ -28,10 +28,18 @@
 
 
 /**
+ * The Class QueryCachingDemo.
+ *
  * @author Brett Meyer
  */
 public class QueryCachingDemo extends AbstractCachingDemo {
 
+	/**
+	 * Gets the project.
+	 *
+	 * @param id the id
+	 * @return the project
+	 */
 	public Project getProject(long id) {
 		final Session s = openSession();
 		s.getTransaction().begin();
@@ -43,6 +51,11 @@ public Project getProject(long id) {
 		return project;
 	}
 
+	/**
+	 * Gets the projects.
+	 *
+	 * @return the projects
+	 */
 	public List<Project> getProjects() {
 		final Session s = openSession();
 		s.getTransaction().begin();
@@ -53,6 +66,12 @@ public List<Project> getProjects() {
 		return projects;
 	}
 
+	/**
+	 * Update project.
+	 *
+	 * @param id the id
+	 * @param name the name
+	 */
 	public void updateProject(long id, String name) {
 		final Session s = openSession();
 		s.getTransaction().begin();
@@ -62,16 +81,27 @@ public void updateProject(long id, String name) {
 		s.getTransaction().commit();
 	}
 
+	/**
+	 * Evict.
+	 */
 	public void evict() {
 		sessionFactory.getCache().evictDefaultQueryRegion();
 	}
 
+	/**
+	 * Prints the stats.
+	 */
 	public void printStats() {
 		System.out.println("query cache put count: " + sessionFactory.getStatistics().getQueryCachePutCount());
 		System.out.println("query cache hit count: " + sessionFactory.getStatistics().getQueryCacheHitCount());
 		System.out.println("query cache miss count: " + sessionFactory.getStatistics().getQueryCacheMissCount());
 	}
 
+	/**
+	 * The main method.
+	 *
+	 * @param args the arguments
+	 */
 	public static void main(String[] args) {
 		final QueryCachingDemo demo = new QueryCachingDemo();
 		final long projectId = demo.persistData();

hibernate-orm/core/Caching/src/main/java/org/hibernate/brmeyer/demo/SecondLevelCachingDemo.java

@@ -26,10 +26,18 @@
 
 
 /**
+ * The Class SecondLevelCachingDemo.
+ *
  * @author Brett Meyer
  */
 public class SecondLevelCachingDemo extends AbstractCachingDemo {
 
+	/**
+	 * Gets the project.
+	 *
+	 * @param id the id
+	 * @return the project
+	 */
 	public Project getProject(long id) {
 		final Session s = openSession();
 		s.getTransaction().begin();
@@ -38,6 +46,12 @@ public Project getProject(long id) {
 		return project;
 	}
 
+	/**
+	 * Gets the user.
+	 *
+	 * @param id the id
+	 * @return the user
+	 */
 	public User getUser(long id) {
 		final Session s = openSession();
 		s.getTransaction().begin();
@@ -46,16 +60,29 @@ public User getUser(long id) {
 		return user;
 	}
 
+	/**
+	 * Evict project.
+	 *
+	 * @param projectId the project id
+	 */
 	public void evictProject(long projectId) {
 		sessionFactory.getCache().evictEntity( Project.class, projectId );
 	}
 
+	/**
+	 * Prints the stats.
+	 */
 	public void printStats() {
 		System.out.println("2lc put count: " + sessionFactory.getStatistics().getSecondLevelCachePutCount());
 		System.out.println("2lc hit count: " + sessionFactory.getStatistics().getSecondLevelCacheHitCount());
 		System.out.println("2lc miss count: " + sessionFactory.getStatistics().getSecondLevelCacheMissCount());
 	}
 
+	/**
+	 * The main method.
+	 *
+	 * @param args the arguments
+	 */
 	public static void main(String[] args) {
 		final SecondLevelCachingDemo demo = new SecondLevelCachingDemo();
 		final long projectId = demo.persistData();

hibernate-orm/core/Caching/src/main/java/org/hibernate/brmeyer/demo/entity/Project.java

@@ -30,41 +30,77 @@
 import org.hibernate.annotations.CacheConcurrencyStrategy;
 
 /**
+ * The Class Project.
+ *
  * @author Brett Meyer
  */
 @Entity
 @Cacheable
 @Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
 public class Project {
+	
+	/** The id. */
 	@Id
 	@GeneratedValue
 	private long id;
 
+	/** The name. */
 	private String name;
 
+	/** The assignee. */
 	@ManyToOne
 	private User assignee;
 
+	/**
+	 * Gets the id.
+	 *
+	 * @return the id
+	 */
 	public long getId() {
 		return id;
 	}
 
+	/**
+	 * Sets the id.
+	 *
+	 * @param id the new id
+	 */
 	public void setId(long id) {
 		this.id = id;
 	}
 
+	/**
+	 * Gets the name.
+	 *
+	 * @return the name
+	 */
 	public String getName() {
 		return name;
 	}
 
+	/**
+	 * Sets the name.
+	 *
+	 * @param name the new name
+	 */
 	public void setName(String name) {
 		this.name = name;
 	}
 
+	/**
+	 * Gets the assignee.
+	 *
+	 * @return the assignee
+	 */
 	public User getAssignee() {
 		return assignee;
 	}
 
+	/**
+	 * Sets the assignee.
+	 *
+	 * @param assignee the new assignee
+	 */
 	public void setAssignee(User assignee) {
 		this.assignee = assignee;
 	}

hibernate-orm/core/Caching/src/main/java/org/hibernate/brmeyer/demo/entity/Skill.java

@@ -9,29 +9,55 @@
 import org.hibernate.annotations.CacheConcurrencyStrategy;
 import org.hibernate.annotations.Immutable;
 
+/**
+ * The Class Skill.
+ */
 @Entity
 @Immutable
 @Cacheable
 @Cache(usage = CacheConcurrencyStrategy.READ_ONLY)
 public class Skill {
+	
+	/** The id. */
 	@Id
 	@GeneratedValue
 	private int id;
 
+	/** The name. */
 	private String name;
 
+	/**
+	 * Gets the id.
+	 *
+	 * @return the id
+	 */
 	public int getId() {
 		return id;
 	}
 
+	/**
+	 * Sets the id.
+	 *
+	 * @param id the new id
+	 */
 	public void setId(int id) {
 		this.id = id;
 	}
 
+	/**
+	 * Gets the name.
+	 *
+	 * @return the name
+	 */
 	public String getName() {
 		return name;
 	}
 
+	/**
+	 * Sets the name.
+	 *
+	 * @param name the new name
+	 */
 	public void setName(String name) {
 		this.name = name;
 	}