src/java.xml/share/classes/com/sun/org/apache/xpath/internal/axes/SubContextList.java
author joehw
Wed, 18 Oct 2017 13:25:49 -0700
changeset 47359 e1a6c0168741
parent 47216 71c04702a3d5
permissions -rw-r--r--
8181150: Fix lint warnings in JAXP repo: rawtypes and unchecked Reviewed-by: lancea, rriggs, mullan
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
6
7f561c08de6b Initial load
duke
parents:
diff changeset
     1
/*
7f561c08de6b Initial load
duke
parents:
diff changeset
     2
 * reserved comment block
7f561c08de6b Initial load
duke
parents:
diff changeset
     3
 * DO NOT REMOVE OR ALTER!
7f561c08de6b Initial load
duke
parents:
diff changeset
     4
 */
7f561c08de6b Initial load
duke
parents:
diff changeset
     5
/*
44797
8b3b3b911b8a 8162572: Update License Header for all JAXP sources
joehw
parents: 25868
diff changeset
     6
 * Licensed to the Apache Software Foundation (ASF) under one or more
8b3b3b911b8a 8162572: Update License Header for all JAXP sources
joehw
parents: 25868
diff changeset
     7
 * contributor license agreements.  See the NOTICE file distributed with
8b3b3b911b8a 8162572: Update License Header for all JAXP sources
joehw
parents: 25868
diff changeset
     8
 * this work for additional information regarding copyright ownership.
8b3b3b911b8a 8162572: Update License Header for all JAXP sources
joehw
parents: 25868
diff changeset
     9
 * The ASF licenses this file to You under the Apache License, Version 2.0
8b3b3b911b8a 8162572: Update License Header for all JAXP sources
joehw
parents: 25868
diff changeset
    10
 * (the "License"); you may not use this file except in compliance with
8b3b3b911b8a 8162572: Update License Header for all JAXP sources
joehw
parents: 25868
diff changeset
    11
 * the License.  You may obtain a copy of the License at
6
7f561c08de6b Initial load
duke
parents:
diff changeset
    12
 *
44797
8b3b3b911b8a 8162572: Update License Header for all JAXP sources
joehw
parents: 25868
diff changeset
    13
 *      http://www.apache.org/licenses/LICENSE-2.0
6
7f561c08de6b Initial load
duke
parents:
diff changeset
    14
 *
7f561c08de6b Initial load
duke
parents:
diff changeset
    15
 * Unless required by applicable law or agreed to in writing, software
7f561c08de6b Initial load
duke
parents:
diff changeset
    16
 * distributed under the License is distributed on an "AS IS" BASIS,
7f561c08de6b Initial load
duke
parents:
diff changeset
    17
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
7f561c08de6b Initial load
duke
parents:
diff changeset
    18
 * See the License for the specific language governing permissions and
7f561c08de6b Initial load
duke
parents:
diff changeset
    19
 * limitations under the License.
7f561c08de6b Initial load
duke
parents:
diff changeset
    20
 */
44797
8b3b3b911b8a 8162572: Update License Header for all JAXP sources
joehw
parents: 25868
diff changeset
    21
6
7f561c08de6b Initial load
duke
parents:
diff changeset
    22
package com.sun.org.apache.xpath.internal.axes;
7f561c08de6b Initial load
duke
parents:
diff changeset
    23
7f561c08de6b Initial load
duke
parents:
diff changeset
    24
import com.sun.org.apache.xpath.internal.XPathContext;
7f561c08de6b Initial load
duke
parents:
diff changeset
    25
7f561c08de6b Initial load
duke
parents:
diff changeset
    26
/**
7f561c08de6b Initial load
duke
parents:
diff changeset
    27
 * A class that implements this interface is a sub context node list, meaning it
7f561c08de6b Initial load
duke
parents:
diff changeset
    28
 * is a node list for a location path step for a predicate.
7f561c08de6b Initial load
duke
parents:
diff changeset
    29
 * @xsl.usage advanced
7f561c08de6b Initial load
duke
parents:
diff changeset
    30
 */
7f561c08de6b Initial load
duke
parents:
diff changeset
    31
public interface SubContextList
7f561c08de6b Initial load
duke
parents:
diff changeset
    32
{
7f561c08de6b Initial load
duke
parents:
diff changeset
    33
7f561c08de6b Initial load
duke
parents:
diff changeset
    34
  /**
7f561c08de6b Initial load
duke
parents:
diff changeset
    35
   * Get the number of nodes in the node list, which, in the XSLT 1 based
7f561c08de6b Initial load
duke
parents:
diff changeset
    36
   * counting system, is the last index position.
7f561c08de6b Initial load
duke
parents:
diff changeset
    37
   *
7f561c08de6b Initial load
duke
parents:
diff changeset
    38
   *
7f561c08de6b Initial load
duke
parents:
diff changeset
    39
   * @param xctxt The XPath runtime context.
7f561c08de6b Initial load
duke
parents:
diff changeset
    40
   *
7f561c08de6b Initial load
duke
parents:
diff changeset
    41
   * @return the number of nodes in the node list.
7f561c08de6b Initial load
duke
parents:
diff changeset
    42
   */
7f561c08de6b Initial load
duke
parents:
diff changeset
    43
  public int getLastPos(XPathContext xctxt);
7f561c08de6b Initial load
duke
parents:
diff changeset
    44
7f561c08de6b Initial load
duke
parents:
diff changeset
    45
  /**
7f561c08de6b Initial load
duke
parents:
diff changeset
    46
   * Get the current sub-context position.
7f561c08de6b Initial load
duke
parents:
diff changeset
    47
   *
7f561c08de6b Initial load
duke
parents:
diff changeset
    48
   * @param xctxt The XPath runtime context.
7f561c08de6b Initial load
duke
parents:
diff changeset
    49
   *
7f561c08de6b Initial load
duke
parents:
diff changeset
    50
   * @return The position of the current node in the list.
7f561c08de6b Initial load
duke
parents:
diff changeset
    51
   */
7f561c08de6b Initial load
duke
parents:
diff changeset
    52
  public int getProximityPosition(XPathContext xctxt);
7f561c08de6b Initial load
duke
parents:
diff changeset
    53
}