svn commit: r1438257 - in /myfaces/trinidad/trunk/trinidad-api/src/main/java/org/apache/myfaces/trinidad/model: CollectionModel.java RowLimitMutator.java

[gc...@apache.org]

Author: gcrawford
Date: Thu Jan 24 23:09:11 2013
New Revision: 1438257

URL: http://svn.apache.org/viewvc?rev=1438257&view=rev
Log:
TRINIDAD-2353 Add RowLimitMutator interface 

Thanks to Jing

Added:
    myfaces/trinidad/trunk/trinidad-api/src/main/java/org/apache/myfaces/trinidad/model/RowLimitMutator.java   (with props)
Modified:
    myfaces/trinidad/trunk/trinidad-api/src/main/java/org/apache/myfaces/trinidad/model/CollectionModel.java

Modified: myfaces/trinidad/trunk/trinidad-api/src/main/java/org/apache/myfaces/trinidad/model/CollectionModel.java
URL: http://svn.apache.org/viewvc/myfaces/trinidad/trunk/trinidad-api/src/main/java/org/apache/myfaces/trinidad/model/CollectionModel.java?rev=1438257&r1=1438256&r2=1438257&view=diff
==============================================================================
--- myfaces/trinidad/trunk/trinidad-api/src/main/java/org/apache/myfaces/trinidad/model/CollectionModel.java (original)
+++ myfaces/trinidad/trunk/trinidad-api/src/main/java/org/apache/myfaces/trinidad/model/CollectionModel.java Thu Jan 24 23:09:11 2013
@@ -527,5 +527,21 @@ public abstract class CollectionModel ex
     return;
   }
 
+  /**
+   * Gets the row limit of this collection model. Default is to return UNKNOWN_ROW_LIMIT.
+   * Subclasses should override this method if row limit is enforced.
+   * @return the maximum number of rows this collection can hold, possible return values are:
+   *   A positive number: the maximum number of rows the collection can hold
+   *   UNKNOWN_ROW_LIMIT: row limit is unknown.
+   *   UNLIMITED_ROW: there is no limit
+   */
+  public int getRowLimit()
+  {
+    return UNKNOWN_ROW_LIMIT;
+  }
+
+  public final static int UNLIMITED_ROW = -2;
+  public final static int UNKNOWN_ROW_LIMIT = -1;
+
   private List<RowKeyChangeListener> _rowKeyChangeListeners = new ArrayList<RowKeyChangeListener>(3);    
 }

Added: myfaces/trinidad/trunk/trinidad-api/src/main/java/org/apache/myfaces/trinidad/model/RowLimitMutator.java
URL: http://svn.apache.org/viewvc/myfaces/trinidad/trunk/trinidad-api/src/main/java/org/apache/myfaces/trinidad/model/RowLimitMutator.java?rev=1438257&view=auto
==============================================================================
--- myfaces/trinidad/trunk/trinidad-api/src/main/java/org/apache/myfaces/trinidad/model/RowLimitMutator.java (added)
+++ myfaces/trinidad/trunk/trinidad-api/src/main/java/org/apache/myfaces/trinidad/model/RowLimitMutator.java Thu Jan 24 23:09:11 2013
@@ -0,0 +1,37 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *   http://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.myfaces.trinidad.model;
+
+/**
+ * Identifies a collection whose row limit can be mutated.
+ */
+public interface RowLimitMutator
+{
+  /**
+   * Mutate the row limit of this collection, it returns the old row limit.
+   * @param newLimit the new limit of this collection to set to.
+   *   A positive number: the maximum number of rows the collection can hold.
+   *   CollectionModel.UNKNOWN_ROW_LIMIT: row limit is unknown.
+   *   CollectionModel.UNLIMITED_ROW: there is no limit
+   * @returns the old row limit.
+   * @throws IllegalArgumentException if <em>newLimit</em> is 0 or any negative number
+   *   other than CollectionModel.UNKNOWN_ROW_LIMIT and CollectionModel.UNLIMITED_ROW.
+   */
+  public int setRowLimit(int newLimit);
+}

Propchange: myfaces/trinidad/trunk/trinidad-api/src/main/java/org/apache/myfaces/trinidad/model/RowLimitMutator.java
------------------------------------------------------------------------------
    svn:eol-style = native