Class: TreeHaver::Backends::Java::Node Private

Inherits:
Object
  • Object
show all
Defined in:
lib/tree_haver/backends/java.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Java backend node wrapper (raw backend node)

This is a **raw backend node** that wraps a jtreesitter Node object via JRuby’s Java interop. It provides the minimal interface needed for tree-sitter operations but is NOT intended for direct use by application code.

Architecture Note

Unlike pure-Ruby backends (Citrus, Parslet, Prism, Psych) which define Node classes that inherit from TreeHaver::Base::Node, tree-sitter backends (MRI, Rust, FFI, Java) define raw wrapper classes that get wrapped by TreeHaver::Node.

The wrapping hierarchy is:

Java::Node (this class) → TreeHaver::Node → Base::Node

When you use ‘TreeHaver::Parser#parse`, the returned tree’s nodes are already wrapped in TreeHaver::Node, which provides the full unified API including:

  • #children - Array of child nodes

  • #text - Extract text from source

  • #first_child, #last_child - Convenience accessors

  • #start_line, #end_line - 1-based line numbers

  • #source_position - Hash with position info

  • #each, #map, etc. - Enumerable methods

  • #to_s, #inspect - String representations

This raw class only implements methods that require direct calls to jtreesitter. The wrapper adds Ruby-level conveniences.

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(impl) ⇒ Node

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Node.



696
697
698
 
# File 'lib/tree_haver/backends/java.rb', line 696

def initialize(impl)
  @impl = impl
end

Instance Attribute Details

#impl ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



693
694
695
 
# File 'lib/tree_haver/backends/java.rb', line 693

def impl
  @impl
end

Instance Method Details

#child(index) ⇒ Node?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get a child by index

Parameters:

  • index (Integer) —

    the child index

Returns:

  • (Node, nil) —

    the child node or nil if index out of bounds



718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
 
# File 'lib/tree_haver/backends/java.rb', line 718

def child(index)
  # jtreesitter 0.26.0: getChild returns Optional<Node> or throws IndexOutOfBoundsException
  result = @impl.getChild(index)
  return if result.nil?

  # Handle Java Optional
  if result.respond_to?(:isPresent)
    return unless result.isPresent
    java_node = result.get
  else
    # Direct Node return (some jtreesitter versions)
    java_node = result
  end

  Node.new(java_node)
rescue ::Java::JavaLang::IndexOutOfBoundsException
  nil
end

#child_by_field_name(name) ⇒ Node?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get a child by field name

Parameters:

  • name (String) —

    the field name

Returns:

  • (Node, nil) —

    the child node or nil if not found



741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
 
# File 'lib/tree_haver/backends/java.rb', line 741

def child_by_field_name(name)
  # jtreesitter 0.26.0: getChildByFieldName returns Optional<Node>
  # However, some versions or scenarios may return null directly
  result = @impl.getChildByFieldName(name)
  return if result.nil?

  # Handle Java Optional
  if result.respond_to?(:isPresent)
    return unless result.isPresent
    java_node = result.get
  else
    # Direct Node return (some jtreesitter versions)
    java_node = result
  end

  Node.new(java_node)
end

#child_count ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the number of children

Returns:

  • (Integer) —

    child count



710
711
712
 
# File 'lib/tree_haver/backends/java.rb', line 710

def child_count
  @impl.childCount
end

#each {|Node| ... } ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Iterate over children

Yields:

  • (Node) —

    each child node



763
764
765
766
767
768
 
# File 'lib/tree_haver/backends/java.rb', line 763

def each
  return enum_for(:each) unless block_given?
  child_count.times do |i|
    yield child(i)
  end
end

#end_byte ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the end byte position

Returns:

  • (Integer) —

    end byte



780
781
782
 
# File 'lib/tree_haver/backends/java.rb', line 780

def end_byte
  @impl.endByte
end

#end_point ⇒ Hash

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the end point (row, column)

Returns:

  • (Hash) —

    with :row and :column keys



795
796
797
798
 
# File 'lib/tree_haver/backends/java.rb', line 795

def end_point
  pt = @impl.endPoint
  {row: pt.row, column: pt.column}
end

#has_error? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Check if this node has an error

Returns:

  • (Boolean) —

    true if the node or any descendant has an error



803
804
805
 
# File 'lib/tree_haver/backends/java.rb', line 803

def has_error?
  @impl.hasError
end

#missing? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Check if this node is missing

Returns:

  • (Boolean) —

    true if this is a MISSING node



810
811
812
 
# File 'lib/tree_haver/backends/java.rb', line 810

def missing?
  @impl.isMissing
end

#named? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Check if this is a named node

Returns:

  • (Boolean) —

    true if this is a named node



817
818
819
 
# File 'lib/tree_haver/backends/java.rb', line 817

def named?
  @impl.isNamed
end

#next_sibling ⇒ Node?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the next sibling node

Returns:

  • (Node, nil) —

    the next sibling or nil if none



843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/tree_haver/backends/java.rb', line 843

def next_sibling
  # jtreesitter 0.26.0: getNextSibling returns Optional<Node>
  result = @impl.getNextSibling
  return if result.nil?

  # Handle Java Optional
  if result.respond_to?(:isPresent)
    return unless result.isPresent
    java_node = result.get
  else
    java_node = result
  end

  Node.new(java_node)
end

#parent ⇒ Node?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the parent node

Returns:

  • (Node, nil) —

    the parent node or nil if this is the root



824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
 
# File 'lib/tree_haver/backends/java.rb', line 824

def parent
  # jtreesitter 0.26.0: getParent returns Optional<Node>
  result = @impl.getParent
  return if result.nil?

  # Handle Java Optional
  if result.respond_to?(:isPresent)
    return unless result.isPresent
    java_node = result.get
  else
    java_node = result
  end

  Node.new(java_node)
end

#prev_sibling ⇒ Node?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the previous sibling node

Returns:

  • (Node, nil) —

    the previous sibling or nil if none



862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
 
# File 'lib/tree_haver/backends/java.rb', line 862

def prev_sibling
  # jtreesitter 0.26.0: getPrevSibling returns Optional<Node>
  result = @impl.getPrevSibling
  return if result.nil?

  # Handle Java Optional
  if result.respond_to?(:isPresent)
    return unless result.isPresent
    java_node = result.get
  else
    java_node = result
  end

  Node.new(java_node)
end

#start_byte ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the start byte position

Returns:

  • (Integer) —

    start byte



773
774
775
 
# File 'lib/tree_haver/backends/java.rb', line 773

def start_byte
  @impl.startByte
end

#start_point ⇒ Hash

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the start point (row, column)

Returns:

  • (Hash) —

    with :row and :column keys



787
788
789
790
 
# File 'lib/tree_haver/backends/java.rb', line 787

def start_point
  pt = @impl.startPoint
  {row: pt.row, column: pt.column}
end

#text ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the text of this node

Returns:

  • (String) —

    the source text



881
882
883
 
# File 'lib/tree_haver/backends/java.rb', line 881

def text
  @impl.text.to_s
end

#type ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the type of this node

Returns:

  • (String) —

    the node type



703
704
705
 
# File 'lib/tree_haver/backends/java.rb', line 703

def type
  @impl.type
end